Lark集成
码道Agent Space具备多端IM接入能力,支持将码道Agent Space的Agent能力复用于多个IM平台,并提供统一的配置管理。
本章节将详细介绍如何将码道Agent Space接入Lark,助您快速实现功能集成与流程协同。
约束限制
| 限制类别 | 具体限制 |
|---|---|
| 功能限制 | 一个Lark机器人仅支持对接一个码道Agent Space。 |
操作流程
| 序号 | 操作平台 | 步骤 | 说明 |
|---|---|---|---|
| 1 | Lark开发者后台 | 在码道Agent Space对接Lark机器人时,请提前完成如下操作:
| |
| 2 | 码道Agent Space | 在码道Agent Space中,注册Lark机器人用以接收和回复消息。 | |
| 3 | Lark客户端 码道Agent Space | 通过Lark机器人对码道Agent Space下发任务。 |
步骤一:准备工作
- 创建企业自建应用。
登录Lark开放平台,单击右上角的“开发者后台”,在“企业自建应用”页签中,单击“创建企业自建应用”,创建一个企业自建应用。
- 添加机器人。
进入“添加应用能力”页面,在“按能力添加”页签中,单击机器人下的“添加”,即可为应用添加一个机器人。
- 为机器人添加应用身份权限。
进入“权限管理”页面,单击“开通权限”。在“应用身份权限 tenant_access_token”页签中,为机器人添加如下权限:
- 获取群组信息(im:chat:readonly)
- 获取与发送单聊、群组消息(im:message)
- 获取与更新群组信息(im:chat)
- 获取群组中用户@机器人消息(im:message.group_at_msg:readonly)
- 获取群组中其他机器人和用户@当前机器人的消息(im:message.group_at_msg.include_bot:readonly)
- 读取用户发送给机器人的单聊消息(im:message.p2p_msg:readonly)
- 以应用的身份发消息(im:message:send_as_bot)
- 获取与上传图片或文件资源(im:resource)
- 获取卡片信息(cardkit:card:read)
- 创建与更新卡片(cardkit:card:write)
- 为机器人添加事件和回调。
- 进入“事件与回调”页面,在“事件配置”页签中,选中“订阅方式”下的“使用 长链接 接收事件”,单击“保存”。
此处的“订阅方式”必须选择“使用 长链接 接收事件”。
- 单击“添加事件”,在“应用身份订阅”页签中,添加如下事件。
- 机器人进群(im.chat.member.bot.added_v1)
- 机器人被移出群(im.chat.member.bot.deleted_v1)
- 接收消息(im.message.receive_v1)
- 消息已读(im.message.message_read_v1)
- 在“回调配置”页签中,选中“订阅方式”下的“使用 长链接 接收回调”,单击“保存”。
此处的“订阅方式”必须选择“使用 长链接 接收回调”。
- 单击“添加回调”,搜索添加卡片回传交互(card.action.trigger)并完成添加。
- 进入“事件与回调”页面,在“事件配置”页签中,选中“订阅方式”下的“使用 长链接 接收事件”,单击“保存”。
- 发布应用。
进入“凭证与基础信息”页面,单击页面上方的“创建版本”,提交应用发布申请。随后,前往“应用发布 > 版本管理与发布”页面查看进度。若“版本状态”显示为“已发布”,则说明应用已成功上线。
- 获取应用凭据。
进入“凭证与基础信息”页面,在“应用凭证”中,即可获取App ID和App Secret。后续在码道Agent Space中,连接Lark机器人时需要使用该凭证。
步骤二:码道Agent Space配置
- 参考开启码道Agent Space操作,进入码道Agent Space。
- 在码道Agent Space对话面板中,单击“选择项目文件夹”,选择“打开项目”,打开一个文件夹。 图1 打开一个文件夹
- 在码道Agent Space页面右上角,单击设置图标
,进入码道Agent Space设置页面。 - 选择“IM集成”,单击Lark集成后的“配置”,进入“注册Lark通道”页面。
- 输入6中获取的Lark应用凭证(Client ID/Client Secret),单击“注册”。 图2 完成Lark注册
等待注册完成,当状态由“连接中”变为“已连接”时,说明Lark机器人注册成功。
步骤三:Lark远程控制
- 登录Lark客户端,添加机器人。
- 在Lark机器人中输入想要执行的任务内容,单击“发送”提交任务。
机器人将自动接收到来自码道Agent Space的反馈信息。此外,在Lark客户端还支持使用斜杠命令来触发相应功能,操作更加便捷。
- 根据反馈消息确认任务需求及关键信息,完成任务的创建。
- 查看任务执行结果。
- 在Lark机器人端:Lark机器人接收到来自码道Agent Space的完成反馈,提示任务执行结束并附带产物位置。
- 在码道Agent Space侧:在码道Agent Space界面的“IM消息 > Lark消息”中,您可以实时查看任务执行过程及结果。单击会话聊天界面右上方的产物面板图标
,即可在任务产物列表中查看生成的交付件。