跳转到主要内容

Documentation Index

Fetch the complete documentation index at: https://docs.langbot.app/llms.txt

Use this file to discover all available pages before exploring further.

一键配置(推荐)

LangBot 支持一键创建飞书应用并自动填写凭证,无需手动复制粘贴。
  1. 打开 LangBot WebUI,进入机器人 > 创建机器人
  2. 填写机器人名称,平台/适配器选择 飞书
  3. 在下方出现的一键创建应用区域,点击右侧的 开始 按钮
一键创建飞书应用
  1. 使用飞书扫描弹出的二维码,手机端会进入飞书开放平台的创建智能体应用页面
  2. 可以选择已有应用立即创建新应用:
手机端选择 如果选择已有应用,会展示应用列表供你选择: 选择已有应用
  1. 授权成功后,手机端会显示「配置成功」,同时 LangBot WebUI 中的应用ID、应用密钥等凭证会自动填入
配置成功
  1. 手动填写机器人名称,名称必须与飞书机器人名称一致,否则机器人将无法在群内正常接收消息
手动填写机器人名称
  1. 点击提交,完成创建

手动配置

创建机器人

前往飞书开放平台,登录后,创建企业自建应用/商店应用 (区别介绍) alt text alt text 为应用添加机器人能力: alt text 在权限管理中添加图中所示权限: alt text 如需卡片流式权限则多添加如下图的创建与更新卡片: img_1.png
默认卡片模板如需更换,需要自己去平台适配器的代码中修改卡片模板

对接 LangBot

凭证与基础信息页找到app_idapp_secret alt text 打开LangBot 的 Webui 配置页面,创建一个新的机器人 将相关信息填入表单 alt text 流式相关: 流式相关 填写完成后启动 LangBot,若成功配置,日志中会出现[01-29 23:42:56.796] manager.py (68) - [INFO] : 初始化平台适配器 1: lark的字样,保持 LangBot 运行。
默认使用的是 WebSocket 长连接模式,对应下方的长连接订阅。但某些情况下(如国际版飞书)不具有长连接模式,此时需要使用 Webhook 模式,对应将事件发送到开发者服务器模式,请参考以下配置:
  • enable-webhook:设置为true
  • encrypt-key:设置为事件与回调页面的加密策略中的Encrypt Key
注意,在Webhook模式中,LangBot 需要部署在具有公网 IP 的服务器上,并确保防火墙已开放上方配置的端口。
没有公网服务器? LangBot Cloud 自带域名和 HTTPS,无需自行配置,开箱即用飞书机器人。

配置事件订阅

前往事件与回调页,配置订阅方式为长连接 alt text 并添加事件:接收消息 alt text 设置回调配置,选择使用长连接的回调(如果是webhook则使用webhook) 设置回调配置 添加回调卡片回传交互 添加回调
Webhook 模式配置方式:alt text请先启动 LangBot,在此处填写从 LangBot 获取的 Webhook 地址

发布机器人

点击顶部创建版本,填写版本号等信息,点击下方保存 alt text 在飞书群中添加机器人,即可使用: alt text alt text 私聊也可以直接使用 alt text

常见问题

  • 商店应用机器人创建/保存后无法立刻响应聊天消息,由于app_ticket事件延迟机制,需要等待2分钟左右才可以正常使用。