钉钉接入指南

本指南将帮助您在钉钉中配置 QClaw ,让您可以通过钉钉与 QClaw 完成互联。

一、前置条件

在开始之前,请确保您已满足以下条件:

  • 已在电脑上安装 QClaw
  • 拥有一个钉钉账号,需要有企业/组织/团队
  • 请选择您有开发者权限的组织,或者选择某个组织后获取开发者权限

提示:

如果您的钉钉账号未加入任何企业/组织/团队,需前往钉钉官网登录/注册并创建团队

二、流程指引

整体流程

在钉钉中添加机器人 -> 获取Client ID 和 Client Secret并填入QClaw

详细步骤

方式一:

  1. 登录开发者后台
  2. 在应用开发下,点击立即创建,可一键创建OpenClaw机器人。
  1. 在创建OpenClaw界面,填写机器人基本信息(包括机器人名称、机器人简介和机器人图标),也可直接使用默认的机器人信息,直接点击确定即可。
  1. OpenClaw创建成功后,会自动展示应用的Client ID和Client Secret,请保存好Client ID和Client Secret用于后续使用。

说明:

自动创建的OpenClaw会默认开通Card.Streaming.Write、Card.Instance.Write和qyapi_robot_sendmsg权限,开发者无需再手动申请。

当创建成功后,会自动创建一个应用,如下图所示:

在应用的凭证与基础信息中,也可以获取到应用的Client ID和Client Secret,如下图示:

方式二:在钉钉开放平台中获取Client ID 和 Client Secret

(1)点击右上角「开发者后台」,选择对应组织

注意:

如果系统提示「该账号还未加入组织」,请前往钉钉官网下载客户端并创建团队。

(2)在开发者后台首页,点击「应用开发」,并点击「创建应用」,在弹出的创建窗口中,填写应用名称及应用描述,填写完成后,点击「保存」

(3)应用创建成功后,跳转到「添加应用能力」页面,点击「添加机器人」,填写机器人的基本信息后,点击「发布」

(4)在应用详情页左侧菜单中,点击「权限管理」,在搜索框中分别搜索以下权限,并点击「立即开通」

Card.Streaming.Write
Card.Instance.Write
qyapi_robot_sendmsg

(5)点击页面上方的「查看版本详情」,点击版本详情旁编辑按钮,填写版本描述信息(可参考示图)

注意:

应用必须发布后才能在钉钉中使用!

(6)点击「确认发布」提交审核

(7)在应用详情页左侧菜单中,点击「凭证与基础信息」,查看Client ID 和 Client Secret

在QClaw中配置钉钉

(1)打开 QClaw,点击左下角设置按钮,进入「远控通道」

(2)选择「钉钉」,点击「配置」

(3)填入刚才复制的 Client ID 和 Client Secret,点击「连接」完成绑定

开始使用

钉钉机器人支持两种使用方式:单聊使用群聊使用

(1)单聊使用:在钉钉顶部搜索框中,搜索机器人的名称,点击机器人进入对话窗口,直接发送消息即可。

发送一条简单消息(例如“你好”)进行联通测试。如果配置正确,QClaw 会接收到消息并在钉钉中返回回复。

(2)群聊使用:创建或选择一个群聊,创建群聊时,请确保群的「归属组织」与创建机器人时的组织相同。

添加机器人到群聊,点击群右上角的设置按钮,选择「机器人」,点击「添加机器人」,选择您创建的机器人,确认添加

开始使用:在群里 @机器人 并发送一条简单消息(例如“你好”)进行连通测试。如果配置正确,QClaw 会接收到消息并在钉钉中返回回复。

说明:

如果机器人能够正常回复,说明您已成功完成 QClaw与钉钉的对接🎊

三、常见问题

1、机器人没有响应怎么办?

(1)检查应用状态:确认应用已发布并通过审批

(2)检查 QClaw:确保电脑上的 QClaw 正在运行

(3)检查权限:确认三个权限都已正确开通

2、在群里找不到机器人怎么办?

(1)确认机器人应用已发布

(2)确认群聊的「归属组织」与机器人所属组织相同

(3)尝试重启钉钉客户端