跳转到内容

协议总览

RTC Agent 的协议由三层组成,各司其职:HTTP API 负责认证、WebSocket RPC 承载所有业务操作、实时事件驱动前后端状态同步。

协议用途特点
🔐 认证层HTTPSOAuth2 授权码流程标准 HTTP,兼容所有 OAuth2 Provider
💬 操作层WebSocket RPC会话、消息、Turn、RTC 操作16 个方法,分为 Action 和 Query 两类
📢 事件层WebSocket Pub/Sub实时状态推送双频道(Topic + Live),支持离线恢复

处理用户登录和令牌管理,遵循标准 OAuth2 授权码流程。

3 个端点覆盖完整认证生命周期:

端点方法功能
/oauth2/authorizeGET获取 OAuth2 授权重定向 URL
/oauth2/tokenPOST授权码换取 access_token
/oauth2/refreshPOST刷新 access_token

👉 详细文档:HTTP API

所有业务操作通过 WebSocket RPC 完成——发消息、查会话、提交工具结果,都在一条持久连接上。

4 个业务域,16 个方法

ActionQuery
Sessionclose · update · fork · compactlist · get
Messagesendlist · get
Turnstoplist · get
RTCupdate_status · submit_resultlist · get

👉 详细文档:WebSocket RPC

服务端通过 双频道 架构推送实时事件,兼顾可靠性和低延迟。

频道用途特性
Topic状态变更事件持久化、Offset 追踪、离线恢复
Live流式消息中间 chunks非持久化、低延迟、即发即弃

👉 详细文档:实时事件