feishu_bot

飞书群聊机器人

使用说明

• 飞书官网创建应用并做好相关配置：开发文档
• 在consts.py文件中配置必要参数【PATH_EVENT、APP_ID、APP_SECRET、VERIFY_TOKEN、ENCRYPT_KEY】
• 服务器部署：保持后台运行，将错误信息重定向输出到标准输出中，标准输出内容保存在log文件下
  • 修改 server.py 文件中 sys.path.append 的路径为服务器模块所在路径
  • 运行：nohup python /home/www/feishu-bot/feishu/server.py >> /home/www/feishu-bot/feishu/feishu_bot.log 2>&1 &

models

各种事件、消息格式、类型 event、message

event: 订阅事件格式

• base: Event, EventContent, EventType
• ReceiveMessageEven: 接收10种消息事件详细格式

message: 消息格式

• im：10种消息发送格式

TextMessage, PostMessage, ImageMessage, InteractiveMessage, ShareChatMessage, ShareUserMessage, AudioMessage, MediaMessage, FileMessage, StickerMessage,

• base: SendMessage, MessageContent, MessageType, ReceiveIdType

utils

工具

• AES: 飞书数据解密
• errors: 异常处理、错误代码

apis

提供各种功能接口

• base
  • verify_signature: 安全校验
  • allow_async_call：异步调用注解
• feishu_api: 飞书API基类
• event: 订阅事件监听处理
  • 接收消息
• auth(获取API访问凭证)：app_access_token, tenant_access_token
• message: 发送消息API

client

客户端：发送请求、消息

• base
• client: 同步/异步请求封装（json: requests; 字节流: fetch）

server

服务端：订阅事件

• 接收消息事件

其它

• consts：配置常量
  • SYS_PATH：服务器中项目路径
  • base_url：飞书开放平台服务端 API 的 URL
  • PATH_EVENT：事件订阅请求网址
  • APP_ID, APP_SECRET, VERIFY_TOKEN, ENCRYPT_KEY
  • TOKEN_EXPIRE_TIME, TOKEN_UPDATE_TIME, BATCH_SEND_SIZE
• stores：持久化
  • 内存：MemoryStore
  • Redis：RedisStore