Skip to main content
OpenAPI

OpenAPI 入门

通过 HTTP 调用万有无界 Hub。

万有无界 Hub 通过 HTTP REST 接口对外开放消息与房间能力。

HTTP 接口

方法路径用途
POST/api/v1/messages/send服务端主动向房间发消息
POST/api/v1/messages/syncCommand发送隐藏指令
GET/api/rooms?tenantId=&userId=查询用户房间列表
GET/api/messages?roomId=&afterSeq=&limit=seq 增量拉消息
GET/api/v1/rooms/{roomId}/messages?beforeSeq=&limit=倒序分页拉历史(limit 上限 100)

通用响应结构

所有接口共用统一响应:
字段类型说明
codeint0 表示成功
messagestring响应消息
dataT业务数据
traceIdstring链路追踪 ID
timestamplong响应时间(毫秒)
分页结果字段:total / page / pageSize / totalPages / list / hasNext

第一个请求:发送一条消息

curl -X POST <HUB_BASE_URL>/api/v1/messages/send \
  -H "Content-Type: application/json" \
  -d '{
    "tenantId": "tenant_xxx",
    "roomId": "room_xxx",
    "senderId": "user_xxx",
    "content": "hello"
  }'
发送消息请求字段:
字段必填说明
tenantId租户 ID
roomId房间 ID
senderId发送者 ID
content消息内容;附件场景为 [{type,assertId,assertName}] 序列化字符串
extra扩展字段,JSON 字符串
receiverId指定接收者;提供后只推送给该用户
method推送方法,默认 message.push
accessToken提供时无需传 tenantId / senderId,从令牌自动解析
isStream是否流式,默认 false
msgType1 普通(默认)/ 2 隐藏 / 3 系统
clientMsgId客户端 UUID,用于去重
agentMsgIdAgent 侧消息 ID

下一步