Skip to content

WebSocket 协议

RsClaw 实现了 OpenClaw WebSocket v3 协议,包含 33+ 方法。兼容 OpenClaw 控制面板。

连接

ws://localhost:18888/ws

消息格式

所有消息为 JSON:

json
{
  "type": "method_name",
  "data": { ... }
}

方法列表

会话管理

方法方向说明
chat客户端 -> 服务端发送聊天消息
chat_stream服务端 -> 客户端流式响应片段
chat_end服务端 -> 客户端响应结束
clear_session客户端 -> 服务端清除当前会话
get_sessions客户端 -> 服务端列出所有会话
get_history客户端 -> 服务端获取会话历史
delete_session客户端 -> 服务端删除会话

设备与配对

方法方向说明
register_device客户端 -> 服务端注册设备
pair客户端 -> 服务端提交配对码
get_devices客户端 -> 服务端列出已配对设备
revoke_device客户端 -> 服务端撤销设备

配置

方法方向说明
get_config客户端 -> 服务端获取当前配置
update_config客户端 -> 服务端更新配置
get_models客户端 -> 服务端列出模型
set_model客户端 -> 服务端切换模型

状态

方法方向说明
get_status客户端 -> 服务端网关状态
get_channels客户端 -> 服务端已连接通道
health客户端 -> 服务端健康检查

智能体控制

方法方向说明
spawn_agent客户端 -> 服务端启动子智能体
list_agents客户端 -> 服务端列出运行中的智能体
kill_agent客户端 -> 服务端终止智能体

流式示例

javascript
const ws = new WebSocket('ws://localhost:18888/ws');

ws.onopen = () => {
  ws.send(JSON.stringify({
    type: 'chat',
    data: {
      message: '你好!',
      session_id: 'my-session',
      stream: true,
    }
  }));
};

ws.onmessage = (event) => {
  const msg = JSON.parse(event.data);
  switch (msg.type) {
    case 'chat_stream':
      process.stdout.write(msg.data.content);
      break;
    case 'chat_end':
      console.log('\n[完成]');
      break;
  }
};

Released under MIT / Apache-2.0 License