获取进入 TRTC 房间密钥

最近更新时间:2025-06-13 14:37:22

我的收藏

接口说明

当创建会话时选择了 TRTC 协议,除数字人之外的其他用户若需加入房间使用此接口获取该用户的入房密钥。
注意:
仅适用于使用数智人内部 TRTC 账号的情况。

调用协议

HTTPS + JSON
POST /v2/ivh/sessionmanager/sessionmanagerservice/gettrtcsign
Header Content-Type: application/json;charset=utf-8

请求参数

参数名称
必选
类型
描述
ReqId
String
单次请求唯一标识。
SessionId
string
会话 id。
RoomId
int
int 类型房间 id,RoomId 和 StrRoomId 必填一个,都填时以 int 类型房间号为准。
StrRoomId
string
string 类型房间号 id,RoomId 和 StrRoomId 必填一个,都填时以 int 类型房间号为准。
UserId
string
加入房间的用户 id。

返回参数

参数名称
必选
类型
描述
ReqId
String
单次请求唯一标识。
UserSig
string
房间密钥。
PrivateMapKey
string
权限密钥。

请求示例

{
"Header": {},
"Payload": {
"ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
"SessionId": "8da33dd4a662ad5b",
"RoomId": 1200111,
"UserId": "avcvdafasfds"
}
}

返回示例

{
"Header": {
"Code": 0,
"Message": "",
"RequestID": "s7aa08das3dd4a662ad5b4508c5b77cg"
},
"Payload": {
"ReqId": "d7aa08da33dd4a662ad5be508c5b77cf",
"UserSig": "vafdasfda",
"PrivateMapKey": "2ad5be508c"
}
}