钉钉集成
本指南将帮助您为OfficeAce集成钉钉。集成后,您可以通过钉钉给OfficeAce下达指令并进行对话,实现移动端随时随地的智能体交互。
运作机制:
钉钉集成的消息流转路径为:用户在钉钉中发送消息 → 钉钉服务器将消息推送至OfficeAce → OfficeAce调用智能体进行处理 → 处理结果返回钉钉并展示给用户。
步骤一:创建钉钉机器人
本步骤需在钉钉开发者后台完成。
- 创建应用。
- 添加机器人能力。应用创建成功后,会自动跳转至“添加应用能力”页面,选择添加机器人。 图2 添加机器人
- 配置机器人信息。打开机器人配置,填写以下信息。
表1 参数说明 参数
说明
机器人名称
机器人在钉钉中显示的名称
机器人简介
简要描述机器人的功能,便于用户了解用途
机器人描述
详细描述机器人的能力和使用方式
消息预览图
上传一张机器人消息预览图
图3 配置机器人信息
- 发布机器人。配置完成后,在页面下方单击“发布”。 图4 发布机器人
- 配置应用权限。
为保证机器人能正常收发消息,需要在“权限管理”中配置相关权限。
依次搜索并开通以下权限:Card.Streaming.Write、Card.Instance.Write、qyapi_robot_sendmsg。权限说明如表2所示。
表2 权限说明 权限名称
用途
Card.Streaming.Write
允许机器人发送流式卡片消息,用于实时展示回复内容
Card.Instance.Write
允许机器人创建和更新交互式卡片,用于消息展示和交互
qyapi_robot_sendmsg
允许机器人通过API发送消息,用于向用户推送回复
图5 开通机器人权限
- 创建并发布应用版本。
- 在左侧导航栏中选择“版本管理与发布”,并“创建新版本”。 图6 创建新版本
- 填写版本号、版本描述,并选择应用可用范围后单击“保存”并按提示进行发布。
- 在左侧导航栏中选择“版本管理与发布”,并“创建新版本”。
- 获取应用凭证。 在“凭证与基础信息”页面获取Client ID、Client Secret,用于步骤二:在OfficeAce集成钉钉配置OfficeAce的对接信息。
Client ID和Client Secret是钉钉应用的鉴权凭证。在步骤二:在OfficeAce集成钉钉中,Client ID对应填写至“App Key”字段,Client Secret对应填写至“App Secret”字段。
Client Secret属于敏感凭证,请妥善保管,切勿泄露或提交至公开代码仓库。
图8 获取凭证信息
步骤二:在OfficeAce集成钉钉
- 登录OfficeAce。
- 在左侧导航栏中选择“渠道”,在渠道列表中选择“钉钉”。
- 填写步骤一:创建钉钉机器人中获取的Client ID填写至“App Key”、将Client Secret填写至“App Secret”。
- 填写完成后单击“测试连接”,连接成功后单击“保存配置”。
如果测试连接失败,请检查:①Client ID和Client Secret是否填写正确且未多余空格;②钉钉应用是否已成功发布;③三项权限是否已全部开通。
图9 在OfficeAce对接钉钉
步骤三:开始使用
常用指令
OfficeAce支持通过特殊前缀指令控制会话,常用指令如下表3所示。




