文档概览/
获取房间成员列表/

获取房间成员列表

功能说明

App 管理员可以通过该接口获取房间成员列表。

接口调用说明

请求 URL 示例

https://xxxxxx/v4/live_engine_http_srv/get_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
注意：
在线成员列表总体更新粒度为40s。
当房间超过1000人时，接口仅返回1000人。

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明，更多参数详情请参见 REST API 简介。
参数
说明
xxxxxx
SDKAppID 所在国家/地区对应的专属域名：
中国：console.tim.qq.com
新加坡：adminapisgp.im.qcloud.com
v4/live_engine_http_srv/get_member_list
请求接口
sdkappid
创建应用时分配的 SDKAppID
identifier
必须为 App 管理员账号，更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名，具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数，取值范围0 - 4294967295
contenttype
请求格式固定值为 json

最高调用频率

200次/秒。

请求包示例

基础形式
{
    "Next": "" // 首次为空字符串，下次请求为之前响应里的Next，直到为空字符串表示已经获取完毕
}

请求包字段说明

字段
类型
属性
说明
Next
String
必填
分页获取参数

应答包体示例

基础形式
{
  "ErrorCode": 0, 
  "ErrorInfo": "",
  "ActionStatus": "OK",
  "RequestId": "requestId-123-456",
  "Response" : {
    "Next": "",  //返回空表示所有成员获取完毕
    "MemberCount": 2, //房间总人数
    "MemberList":[
      {
        "Member_Account" : "brennan1"
      },
      {
        "Member_Account" : "tandy"
      },
   ] 
  }
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果，OK 表示处理成功，FAIL 表示失败
ErrorCode
Integer
错误码，0表示成功，非0表示失败
ErrorInfo
String
错误信息
RequestId
String
唯一请求 ID，每次请求都会返回，定位问题时需要提供该次请求的 RequestId
MemberList
Array
房间成员列表
Next
String
下次请求参数里的Next值
MemberCount
Integer
房间总人数

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码（TUILiveKit） 文档。
本 API 私有错误码如下：
错误码
含义说明
100001
系统错误，重试
100004
房间不存在，原因可能是房间没被创建过，或者已经被解散了
100006
表示此房间不是 live 房间，无权限使用 live 接口查询