CodeBuddy 企微助理

配置 WorkBuddy 企微智能机器人,让可以以通过企业微信随时随地远程操控电脑上的 WorkBuddy 完成任务。

相关产品
CodeBuddy 产品页,含版本规格、价格与购买入口。

一、在开始之前

请确保你已满足以下条件:

·已安装 WorkBuddy:已在电脑上安装 WorkBuddy>= 4.6.4,并开启了助理远程控制功能。

·拥有企业微信账号:拥有一个可创建智能机器人的企业微信账号。

注意:说明:

注意:如果你还没有企业微信账号,可以前往 企业微信页面 免费注册一个企业。

二、快速接入

1. 进入设置页。

打开 WorkBuddy,在左侧助理栏单击齿轮图标,进入助理设置。

2. 配置集成。

在集成列表中找到企微助理集成,单击右侧的配置,在弹窗中选择快捷绑定接入。

3. 企微扫码授权。

使用企业微信扫描二维码完成以下配置后,WorkBuddy 桌面端自动填入Bot ID 和 Secret ,单击注册完成绑定:

·一键创建企业微信智能机器人

·确认授权获取对话用户信息、新建和编辑文档能力

三、创建企业微信智能机器人

1. 选择创建入口。

请根据你的账号角色选择对应入口:

·管理员:打开浏览器,访问 企业微信管理后台,使用管理员账号登录后,依次单击安全与管理 > 管理工具 > 智能机器人 > 创建机器人。

·普通成员:打开企业微信客户端,进入工作台 > 智能机器人应用 > 创建机器人。

2. 进入 API 模式创建流程。

进入机器人创建页面后,按以下方式切换到 API 模式:

·管理员:在创建页面直接选择 API 模式创建。

·普通成员:如果先进入 AI 自动生成页面,请单击左下角的手动创建,再选择 API 模式创建。

3. 完成长连接接入前的公共配置。

·公共配置:

配置项 说明
机器人名称 建议填写容易识别的名字,如 WorkBuddy 助手
可见范围 选择哪些员工、部门或标签可以使用这个机器人

注意:说明:

注意:以下截图主要以企业微信管理后台页面为例,不同入口的界面文案可能略有差异,但后续配置项一致。

·设置可见范围:单击可见范围后的添加,选择需要使用机器人的成员、部门或标签。

完成以上配置后,请先单击页面底部的保存,再在右侧 API 配置区域选择使用长连接。

四、关于 API 模式

企业微信 API 模式支持两种接入方式,推荐优先使用长连接模式:

·长连接模式(推荐):在 WorkBuddy 中填写 Bot ID 和 Secret 即可完成绑定,配置更简单,无需回填 Webhook URL。

·URL 回调模式:适用于需要 Webhook 回调的场景;需在 WorkBuddy 中填写 Token 和 Encoding-AESKey,生成 Webhook URL 后再回填到企业微信。

注意:说明:

注意:下文主流程以长连接模式为例,URL 回调模式放在文末作为备选方案。

五、使用长连接模式接入

1. 在企业微信中获取 Bot ID 和 Secret。

在 API 配置区域选择使用长连接,复制 Bot ID;单击“点击获取”以获取 Secret,并妥善保存。

注意:说明:

注意:长连接模式不需要再填写 URL、Token 或 Encoding-AESKey。

2. 在 WorkBuddy 中完成绑定。

·打开 WorkBuddy,在左侧助理栏单击齿轮图标,进入助理设置。

·找到企微助理集成,单击配置,在弹窗中选择 WebSocket 长连接,填入刚才复制的 Bot ID 和 Secret,单击注册完成绑定。

六、使用 URL 回调接入

如果你已经在使用 Webhook 配置,或因网络、部署限制需要通过 URL 回调接入,可按以下步骤操作。

1. 在企业微信中生成回调凭据。

·在 API 配置区域选择使用 URL 回调

·单击 Token 和 Encoding-AESKey 输入框右侧的随机获取

·保存这两个参数,后续需要在 WorkBuddy 中使用

注意:请务必保存好 Token 和 Encoding-AESKey,否则后续无法完成注册。

2. 在 WorkBuddy 中生成 Webhook URL。

·进入 WorkBuddy 助理设置,单击企微助理集成的配置,在注册弹窗中切换到使用 URL 回调

·填入刚才获取的 Token 和 Encoding-AESKey,单击注册

·注册成功后,复制生成的 Webhook URL

3. 回填 Webhook URL 。

回到企业微信的机器人创建页面,将刚才复制的 Webhook 地址粘贴到 URL 输入框,单击保存完成配置。

七、开始使用

配置完成后,你就可以在企业微信中直接与机器人对话了。

1. 在企业微信通讯录的企业创建的分组下找到刚刚创建的机器人,单击发消息即可开始下发任务。

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

注意:说明:

注意:如果机器人能够正常回复,说明你已成功完成 WorkBuddy 与企业微信的对接。

八、机器人没有响应

请按以下步骤排查:

1. 检查 WorkBuddy 状态:确保电脑上的 WorkBuddy 正在运行,且助理服务已开启。

2. 核对接入方式:确认企业微信与 WorkBuddy 中选择的是同一种接入方式。

3. 检查凭据:长连接模式请核对 Bot ID 和 Secret;URL 回调模式请核对 Token 和 Encoding-AESKey。

4. 检查网络连接:确保电脑能够正常访问网络。

九、URL 验证失败

1. 确保 WorkBuddy 处于运行状态。

2. 检查助理服务是否已正常启动。

3. 重新复制 Webhook URL,确保没有遗漏或多余字符。

4. 确认 Token 和 Encoding-AESKey 与 WorkBuddy 中配置的完全一致。

十、长连接注册失败

1. 确认企业微信侧已选择使用长连接。

2. 重新复制 Bot ID 和 Secret,避免带入多余空格。

3. 如 Secret 已失效,可在企业微信后台重新获取后再次注册。

赞 (0)
上一篇 4天前
下一篇 4天前