参赛插件接入调试台

WesomeAI OpenClaw Channel 接入指南

这是给参赛人员使用的联调页面。按步骤填入凭证、生成 agentId、建立 WebSocket、处理平台消息,并把 OpenClaw 执行结果 reply 回 WesomeAI。

Token 未获取
AgentId 未绑定
WebSocket 未连接

Step 0

全局配置

ServerUrl平台 HTTP base URL,示例包含 /backend-api,不要在末尾加斜杠。
WebSocketUrl用于 Step 4 建立长连接;开启连接接口返回 endpoint 时,也会优先使用这里填写的地址。
OpenClaw 本地接口如果未启动本地 OpenClaw,可用 Step 5 的“模拟 OpenClaw”完成本地联调闭环。
设备名称建议使用无空格标识,例如 OpenClawDevice,避免不同语言或 shell 处理空白时产生歧义。
安全提醒 这个页面只用于本地联调。提交参赛作品时,不要把 appSecret、accessToken、ticket、Authorization 写进前端代码、日志或公开仓库;真实插件应把它们放在服务端配置、环境变量或密钥管理系统中。

Step 1

获取 accessToken

你的插件服务端用 appKey/appSecret 换取 accessToken。后续 Step 3 开启连接和 Step 6 reply 都要带这个 token。 accessToken 有有效期,参赛作品的服务端需要缓存它,并在过期前刷新;日志里只记录是否成功和过期时间,不要输出 token 明文。

方法
POST
路径
/authen/v1/access_token/internal
Header
Content-Type: application/json
成功条件
code = 200 或 code = 0,且 data.accessToken 存在
请求体

              

本步骤运行日志

暂无日志

Step 2

设备绑定并保存 agentId

首次接入时不要手动猜 agentId。请用平台登录后的 Authorization 调用设备绑定接口,把响应里的 data 保存为 agentId。 后续收到 INIT_AGENT、AGENT_CREATED 或 AGENT_MESSAGE 时,也要用消息里的 agentId 刷新本地绑定关系。

configJson 原始对象

              
绑定接口请求体

              

本步骤运行日志

暂无日志

Step 3

开启平台连接

这一步告诉平台你的插件要订阅哪些消息。平台会返回 WebSocket endpoint 和一次性 ticket。 Step 4 必须使用这两个字段拼接连接地址,否则不知道要连哪个 WebSocket,也没有本次连接的鉴权参数。 执行成功后,响应里的 endpointticket 会自动同步到 Step 4 的连接地址预览。

Header
Authorization: Bearer <accessToken>
Header
x-platform: pc
订阅
CALLBACK/AGENT_MESSAGE、EVENT/*、SYSTEM/*
请求体

              

本步骤运行日志

暂无日志

Step 4

WebSocket 消息处理

使用 Step 3 返回的 endpoint 和 ticket 拼出连接地址:endpoint?ticket=encodeURIComponent(ticket)。 连接成功后,你的插件至少要处理三类消息:SYSTEM/PING 立即回复 pong;EVENT/INIT_AGENT 或 AGENT_CREATED 更新 agentId/userId;CALLBACK/AGENT_MESSAGE 提取 userId、conversationId、msgId 和 message.content,然后触发 OpenClaw。

WebSocket 连接地址

            
平台下发 AGENT_MESSAGE

              
PING 对应 PONG

              

本步骤运行日志

暂无日志

Step 5

调用本地 OpenClaw 适配层

平台消息不要直接散落到业务代码里。建议先转换成稳定的 OpenClaw 输入结构,例如 channel、agentId、userId、conversationId、messageId、text 和 raw。 之后无论你用 HTTP、SDK、CLI 还是本地 wrapper 调 OpenClaw,都只维护这一层转换。

OpenClaw 输入

              
OpenClaw 输出

              

本步骤运行日志

暂无日志

Step 6

回复消息形成闭环

reply API 使用平台消息里的 msgId 作为路径参数,body 内带 agentId、receiveId、conversationId、msgType、content 和 is_last。 receiveId 通常是平台消息里的 userId;conversationId 来自同一条 AGENT_MESSAGE。发送成功后,用户会在 WesomeAI Web Platform 看到 OpenClaw 的回复。

方法
POST
路径
/open-apis/im/v1/messages/{messageId}/reply
receiveId
平台消息里的 userId
conversationId
平台消息里的 conversationId
请求体

              

本步骤运行日志

暂无日志

Runbook

提交前自检

基础闭环

能获取 token、绑定设备、开启连接、收到 AGENT_MESSAGE、调用 OpenClaw,并 reply 回平台。

状态持久化

重启后能读取 agentId、userId、conversationId 等必要状态;收到 INIT_AGENT 或 AGENT_CREATED 时能刷新绑定。

连接可靠性

PING 要及时回 pong;WebSocket 断开后用退避策略重连;鉴权失败不要盲目重试。

日志安全

appSecret、accessToken、ticket、Authorization 等敏感字段必须脱敏。