获取麦位列表

最近更新时间:2023-08-08 14:54:52

我的收藏

功能说明

管理员可通过该接口查询房间内麦位列表。(仅直播场景支持)

接口说明

请求 URL 示列

https://xxxxxx/room_api/v1/seatctl/get/seat_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名:
中国:roomkit.trtc.tencent-cloud.com
room_api/v1/roomctl/get/seat_list
请求接口
sdkappid
创建应用时控制台分配的 SDKAppID
identifier
使用 IM 的管理员账号
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围 0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

基础形式 获取麦位列表
{
"roomId": "12983123"
}

请求包字段说明

字段
类型
属性
说明
roomId
String
必填
房间 ID

响应包字段

{
"errorCode": 0,
"errorMessage": "Success",
"requestId": "eff68168a556c50a2302f6844ab01d07",
"data": {
"seatList": [
{
"index": 0,
"userId": "",
"isLocked": false,
"isVideoLocked": false,
"isAudioLocked": false
},
{
"index": 1,
"userId": "test",
"isLocked": false,
"isVideoLocked": false,
"isAudioLocked": false
},
{
"index": 2,
"userId": "",
"isLocked": false,
"isVideoLocked": false,
"isAudioLocked": false
},
{
"index": 3,
"userId": "",
"isLocked": false,
"isVideoLocked": false,
"isAudioLocked": false
},
{
"index": 4,
"userId": "",
"isLocked": true,
"isVideoLocked": true,
"isAudioLocked": true
}
]
}
}

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。实际的错误码、错误信息是通过应答包体中的 errorCode、errorMessage 来表示的。 公共错误码(70000到79999)请参见 错误码
错误码
含义说明
0
请求成功
85001
麦位超出最大数量限制
85002
麦位被锁后将无法上麦,解锁后才可以上麦
85003
该用户已经在当前麦位上
85004
当前麦位已被使用
85005
当前麦位不存在
85006
当前麦位音频被锁,无法打开麦克风,解锁后才可使用
85007
当前麦位视频功能被锁,无法打开摄像头,解锁后才可使用
85008
仅直播场景支持
未知错误码
未知错误,请联系技术人员

可能触发的回调

暂无。