获取麦位列表
功能说明
App 管理员可以通过该接口获取麦位列表。
接口调用说明
请求 URL 示例
https://xxxxxx/v4/room_engine_http_mic/get_seat_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名: 新加坡: adminapisgp.im.qcloud.com |
v4/room_engine_http_mic/get_seat_list | 请求接口 |
sdkappid | 创建应用时即时通信 IM 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数,取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
基础形式
{"RoomId":"room-test"}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
RoomId | String | 必填 | 房间 ID |
应答包体示例
基础形式
{"ErrorCode": 0,"ErrorInfo": "","ActionStatus": "OK","RequestId": "Id-7c1680be52734bdc8d6de398ab9505e7-O-Seq-57717","Response": {"SeatList": [{"Index": 0,"Member_Account": "user2","IsTakenDisabled": false,"IsVideoDisabled": false,"IsAudioDisabled": false},{"Index": 1,"IsTakenDisabled": false,"IsVideoDisabled": false,"IsAudioDisabled": false}]}}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果,OK 表示处理成功,FAIL 表示失败 |
ErrorCode | Integer | 错误码,0表示成功,非0表示失败 |
ErrorInfo | String | 错误信息 |
RequestId | String | 唯一请求 ID,每次请求都会返回,定位问题时需要提供该次请求的 RequestId |
SeatList | Array | 麦位列表 |
Index | Integer | 麦位号 |
Member_Account | String | 麦位上的用户 ID,空表示麦上没有用户 |
IsTakenDisabled | Bool | 麦位锁定 |
IsVideoDisabled | Bool | 禁止麦位视频流 |
IsAudioDisabled | Bool | 禁止麦位音频流 |
错误码说明
除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:
错误码 | 含义说明 |
100001 | 服务器内部错误,请重试 |
100002 | 请参数非法,请根据错误描述检查请求是否正确 |
100004 | 房间不存在,或者曾经存在过,但是目前已经被解散 |