Skip to content

服务端接口

本文档说明业务服务端如何对接 AI 对讲相关接口。角色管理、设备与角色绑定等 OpenAPI 以 Apifox 文档为准;本文只展开 AI 对讲连接凭证申请接口。

鉴权方式 (TGV1-HMAC-SHA256)

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

角色与设备绑定 OpenAPI

获取角色、设备绑定角色、查询设备绑定角色等 OpenAPI 的详细接口定义与在线调试,请参阅 探鸽 OpenAPI 文档 (Apifox)

申请连接凭证

向探鸽平台申请供设备建立 TiRTC 连接的短效凭证 peer_idtoken。凭证有效期较短(通常为分钟级),设备端应在获取后尽快使用。

  • 请求地址POST https://api-tirtc.tange365.com/v1/token/aichat

请求头

Header说明
Content-Typeapplication/json
AuthorizationTGV1 签名授权行
X-Tg-Algorithm签名算法名称,固定为 TGV1-HMAC-SHA256
X-Tg-Date请求时间(UTC 格式)
X-Tg-App-Id应用 ID,需与凭证中的 app_id 一致
X-Tg-Content-Sha256请求 Body 的 SHA-256 哈希值(小写十六进制)
X-Tg-Signed-Headers参与签名的 Header 名称列表

以上 TGV1 相关 Header 的格式与签名步骤,详见 TGV1-HMAC-SHA256 签名算法

请求 Body

json
{
  "device_id": "DEMO_DEVICE_01",
  "role_id": "role_xxx"
}
字段类型必填说明
device_idstring设备 ID,需已在探鸽平台注册并绑定应用。
role_idstring角色 ID,来自控制台角色配置或设备角色绑定查询。

响应示例

json
{
  "code": 0,
  "msg": "ok",
  "data": {
    "peer_id": "whips://aichat?device_id=DEMO_DEVICE_01&role_id=role_xxx",
    "token": "v1.{payload}.{signature}"
  }
}
  • code0 时不要把响应下发给设备。
  • peer_idtoken 应由业务服务端通过安全通道下发给设备,作为设备端 TiRtcWhipConnect 的入参。
  • 凭证为短效凭证,获取后应尽快使用,避免因过期导致建连失败。

错误码

/v1/token/aichat 常见错误

错误码HTTP 状态码说明
AuthFailure.SignatureFailure401签名校验失败。检查 CanonicalURIX-Tg-Date 时间偏差和 Body SHA-256 是否正确。
AuthFailure.TokenExpired401请求签名中的时间戳过期。确保 X-Tg-Date 与服务端时间偏差不超过允许范围。
InvalidParameter400请求参数错误,例如 device_idrole_id 为空。
ResourceNotFound.Device404设备未注册或未绑定到当前应用。
ResourceNotFound.Role404角色不存在或未发布。
LimitExceeded429请求频率超出限制。请降低调用频率后重试。
InternalError500平台内部错误。请携带 request_id 联系技术支持。

角色与设备绑定相关错误码请查阅 探鸽 OpenAPI 文档 (Apifox)

AI Chat 文档