注意:为什么选择 TIMBot-WS?
注意:与基于 Webhook 回调 + REST API 的 TIMBot 插件相比,TIMBot-WS 采用 WebSocket 长连接方案,具备“无需公网 IP”的独特优势。
一、前置条件
在开始前,请确保你已具备以下环境:
·OpenClaw 环境:拥有一只“小龙虾”(即部署好的 OpenClaw 实例)。如尚未部署,可前往腾讯云 CVM 服务器部署。参考 云服务器 CVM ;已有 OpenClaw 的用户可直接跳过此步。
·腾讯云资源:注册腾讯云账号,用于访问即时通信 IM 控制台。
二、步骤 1:创建 IM 应用并获取凭证
1. 登录 即时通信 IM 控制台,在左侧导航栏选择应用管理,点击创建新应用。
2. 在弹出界面中依次输入应用名称、选择数据中心、设置标签信息(可选)。
3. 创建完成后进入应用详情页,在应用信息模块中找到并记录以下两个关键参数,用于后续鉴权:
·SDKAppID:应用的唯一标识 ID。
·SecretKey(密钥):用于生成鉴权签名的密钥。
三、步骤 2:获取机器人账号的 UserID 和 UserSig
timbot-ws 插件支持配置普通账号或机器人账号,两者的区别是:
| | 普通账号 | 机器人账号 |
| 创建账号 | 普通账号是 IM SDK 的基础用户账号,通过 UserID 唯一标识,具有完整的即时通讯能力。可通过 控制台 或 REST API 创建。 | 机器人账号是一种特殊的用户账号,它也通过 UserID 来唯一标识(但是其 UserID 必须以@RBT#开头),具有昵称、头像、签名等基本属性。 |
| 特性 | 无限制。 | 通过 REST API 创建一个机器人账号。作为一种限制性的账号,机器人只有普通账号的部分功能,如收发消息,加入群组等,但同时机器人账号也可以实现一些普通账号不具有的特性与功能,例如 支持流式消息、发消息不检验好友关系、加群无上限、单聊机器人消息回调、群内@机器人之后回调 等。详见 创建机器人。 |
下面以普通账号演示接入流程。
普通账号机器人账号
1. 登录 即时通信 IM 控制台,点击左侧导航栏的消息服务 Chat > 账号管理,分别新建 robot 和 human 账号。2. 在控制台左侧导航栏选择 UserSig 生成校验,输入用户名,点击生成签名(UserSig)。注意:控制台的签名(UserSig)生成工具仅供测试开发阶段使用,如你正式上线,请参考正式运行阶段计算 UserSig。3. 点击复制签名(UserSig) 按钮,获取 robot 和 human 账号的 UserSig。4. 互相添加好友。在发起聊天前,请你参考 REST API 将机器人账号 robot 与你的测试账号 human 互相添加好友。
1. 创建机器人账号。通过 REST API 创建一个机器人账号。
2. 输入 Json 参数中设置机器人的相关信息:
·UserID: 机器人的 ID(本 Demo 中固定使用 @RBT#001)。
·Nick: 机器人的名称。
·FaceUrl: 机器人头像的地址。
·SelfSignature:机器人签名。
3. 在控制台左侧导航栏选择 UserSig 生成校验,输入机器人的 UserID,点击生成签名(UserSig)。
注意:控制台的签名(UserSig)生成工具仅供测试开发阶段使用,如你正式上线,请参考正式运行阶段计算 UserSig。
4. 点击复制签名(UserSig) 按钮,获取机器人账号的 UserSig。
四、安装插件
openclaw plugins install timbot-ws
五、激活并选择通道
插件安装完成后,需要通过交互命令来激活对应的 Channel。
首先在终端执行命令:
openclaw onboard
运行上面的命令后,提示是否知晓风险,选择 Yes(空格键选择,回车键确认):
Onboarding 模式选择 QuickStart:
选择 Use existing values:
根据实际情况配置可用的模型:
注意:请选择有免费用量或者已经付费的大模型,否则连接成功后将无法体验完整功能。
输入模型的 API Key:
在出现的 Select channel 列表中,找到并选择 Tencent IM (timbot-ws):
输入步骤 1 中获取的 SDKAppID:
输入步骤 2 中获取的机器人的 UserID
输入步骤 2 中获取的机器人的 UserSig:
注意:警告:
注意:在你应用到正式生产环境时,为了保证机器人的登录态有效,建议你生成 10 年有效期的 UserSig。若你的 UserSig 泄露,请通过 RESTful API 使其失效。
至此,timbot-ws 插件的配置已完成,接下来的选项你可以根据实际需求逐一配置,也可以暂时跳过以便快速进入测试环节:
选择不配置 skills:
按下空格键选择 Skip for now:
重启网关:
openclaw gateway restart
六、步骤 4:发起聊天
根据你的实际情况,可以选择以下路径继续:
·已有 IM 应用:如果你已拥有成熟的 IM 应用,完成上述插件配置后即可在应用中和机器人聊天。
·快速体验 OpenClaw 功能:如果你尚未拥有自己的 IM 应用,希望先快速体验 OpenClaw 的效果,请参阅以下内容,按照指引完成 Demo 的搭建与运行。
Web微信小程序
克隆 Timbot-ws 项目到本地,安装依赖并启动 Demo:
# 第一步:克隆项目git clone https://github.com/Tencent-RTC/TIMBot-WS.gitcd TIMBot-WS获取机器人# 第二步:安装依赖并启动 Democd demos/web-im-demonpm installnpm run dev
在 Demo 的登录页面中,填入以下信息:
| 字段 | 说明 |
| SDKAppID | 腾讯云 IM 控制台中的应用 SDKAppID |
| UserID | 一个非机器人的普通用户 ID |
| SecretKey | 应用的 SecretKey(Demo 会自动在本地生成 UserSig) |
发起单人会话:
在聊天框给机器人发送消息,即可看到机器人的回复:
在群聊中 @机器人 发送消息,也可看到机器人的回复:
七、导入项目
下载 clawdbot-wx 项目,在微信开发者工具导入(请使用自己的小程序 AppID)。如需二次开发或集成到自有项目,可获取 uni-app 小程序源码,下载 链接。
请在微信开发者工具中勾选不校验合法域名:
八、和机器人聊天
为了简化流程,请开启小程序开发调试模式:
输入步骤1获取的 SDKAppID 与 SecretKey,用于完成服务鉴权。UserID 可任意填写:系统将自动以此 ID 创建并登录新用户。
登录成功后,打开和机器人的会话,即可开启 OpenClaw 智能体之旅。
现在,你可以开始与 AI 智能体进行对话了!
九、OpenClaw 一直没有回复,如何排查?
openclaw gateway stop && openclaw gateway run –verbose | grep –line-buffered -i 'timbot-ws'
成功通过 WebSocket 通道收到消息:
处理后发送消息成功:
十、如何关闭通道?
如需关闭 timbot-ws 插件通道,请在终端中执行以下命令:
openclaw plugins disable timbot-ws
执行成功后,该插件将被禁用,相关通道连接也会随之关闭。
提示: 如需重新启用该插件,可执行 openclaw plugins enable timbot-ws。
十一、如何修改插件配置的 userId 和 userSig?
方式一:请在终端中执行以下命令
# 修改 userIdopenclaw config set channels.timbot-ws.userId "新的userId"# 修改 userSigopenclaw config set channels.timbot-ws.userSig "新的userSig"# 重新启动网关openclaw gateway restart
方式二:直接编辑配置文件
1. 用任意文本编辑器打开 OpenClaw 配置文件。OpenClaw 的配置文件位于用户主目录下:
·macOS / Linux:~/.openclaw.json
·Windows:%USERPROFILE%\\.openclaw.json
2. 找到 channels → timbot-ws 部分,修改 userId 和 userSig 字段:
{ "channels": { "timbot-ws": { "userId": "@RBT#002", "userSig": "你的UserSig字符串", "sdkAppId": 1400000000 } }}