此为预览文档,正式版本尚未发布。
查询平台要求并创建连接
以下示例使用 Bash、curl 和 jq。先按认证与空间准备 SERVICE_URL(Service 地址)、TOKEN(用户 Bearer token)、TENANT、NAMESPACE,并定义请求函数:
/api/channels,使用平台用户身份和空间请求头。先查询所需凭据、传输方式和回调地址模板:
FEISHU_APP_ID、FEISHU_APP_SECRET、FEISHU_VERIFICATION_TOKEN 设为平台应用的值;外部平台的应用、权限与事件订阅需先配置好。
callbackUrlTemplate 替换 channel ID,并使用部署的公开 HTTPS origin,在飞书侧配置回调。连接类型和必填 properties 随平台而变,不要把飞书字段原样用于其他适配器。
将收到的工作交给 Agent 或 Team
准备同一空间内的TEAM_ID,为该渠道启用工作接待。首次配置读取的版本通常为 0,后续保存都复用当前 version:
targetType:"agent";当前工作路由不支持直接选择 Workflow。defaultTarget 处理未匹配细分规则的消息,routes 可按 accountId、peerKind(DIRECT / GROUP)、peerId、可选 threadId 设置目标。群工作需同时启用 allowGroupWork 并由用户明确发起共享工作。
started:true 表示适配器已经启动,不能证明消息订阅、工作路由和回传都成功。下一步从外部平台发送一个小任务,验证完整往返。
关联用户身份并开始工作
工作接待按实际发消息的用户检查权限。登录用户调用 pairing 获取一次性绑定命令:command 形如 /bind ...,在 expiresInSeconds 指定的有效期内私聊机器人发送,完成外部身份与平台账号关联。之后从该对话提出工作请求;Service 根据路由、访问范围及当前会话关联创建或跟进 Issue。需要解除当前用户关联时调用 DELETE /api/channels/{channelId}/identity。
应用无需调用 /api/internal/channels/... 模拟用户消息;这些路径是受信任适配器的内部交付协议。希望从普通业务系统触发任务时,选择 Issue API 或 Automation Webhook。
跟进接收、执行和回传
POST /api/channels/{channelId}/messages/{messageId}/retry 重试,回传失败使用 /deliveries/{deliveryId}/retry。取消某个外部会话对工作的订阅使用 DELETE /api/channels/{channelId}/links/{linkId};这不会取消 Issue 执行。
更改连接凭据使用 PUT /api/channels/{channelId},读取详情时密钥会被遮盖。启停使用 /enable、/disable,删除使用 DELETE /api/channels/{channelId}。更换凭据或回调设置后,重新验证接收与发送两条路径。
控制台配置表单、工作路由和身份绑定入口见控制台:自动化与渠道。