Skip to content

服务端接口

本文说明 Room 对外服务端接口。业务服务端通过 Token 接口申请短效入房凭证,并把返回的 peer_idtoken 安全下发给设备端。设备端建连请参考设备端集成

鉴权方式(TGV1-HMAC-SHA256)

与探鸽云端 OpenAPI 服务端签名一致,详见服务端 API 接口签名算法 Demo

签发入房 token

POST /v1/token/room

请求头

Header必填说明
Content-Type固定为 application/json
X-Tg-App-Id应用 ID。
AuthorizationTGV1 服务端签名,格式为 TGV1-HMAC-SHA256 Credential=..., SignedHeaders=..., Signature=...

请求 Body

json
{
  "room_id": "order-20260611-001",
  "device_id": "device-001"
}
字段类型必填说明
room_idstring业务侧逻辑房间 ID。
device_idstring设备 ID,默认参与者可映射为 device_{device_id}

响应示例

json
{
  "peer_id": "room_peer_order_20260611_001_device_001",
  "token": "v1.{claimB64}.{sig}"
}

peer_id 是设备端连接目标标识,业务服务端不要解析或改写。设备端调用 TiRTC TiRtcWhipConnect 时,应同时传入这个 peer_idtoken

常见错误

HTTP 状态码说明
400请求参数错误,例如 room_iddevice_id 为空。
401App 鉴权失败,检查应用 ID、TGV1 签名时间、签名 Header 和 Body SHA-256。
403当前应用或设备没有入房权限。
429房间人数超限。
503服务暂不可用,请稍后重试或联系技术支持。

Room 文档