获取房间成员列表

最近更新时间:2024-03-19 09:31:22

我的收藏

功能说明

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

接口调用说明

请求 URL 示例

https://console.tim.qq.com/v4/room_engine_http_srv/get_room_member_list?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参见 REST API 简介
参数
说明
v4/room_engine_http_srv/get_room_member_list
请求接口
sdkappid
创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier
必须为 App 管理员账号,更多详情请参见 App 管理员
usersig
App 管理员账号生成的签名,具体操作请参见 生成 UserSig
random
请输入随机的32位无符号整数,取值范围0 - 4294967295
contenttype
请求格式固定值为json

最高调用频率

200次/秒。

请求包示例

基础形式
{
"RoomId": "room-test",
"Count": 10,
"Next": ""
}

请求包字段说明

字段
类型
属性
说明
RoomId
String
必填
房间 ID
Count
Integer
选填
获取成员数量,默认50
Next
String
选填
上一次拉取到的成员位置,首次调用填写"",续拉使用返回值中的 Next 值

应答包体示例

基础形式
{
"ErrorCode": 0,
"ErrorInfo": "",
"ActionStatus": "OK",
"RequestId": "Id-52f049ba12d741b7a84959700acdb1d5-O-Seq-56287",
"Response": {
"Next": "",
"MemberList": [
{
"Member_Account": "user2",
"NameCard": "123",
"Role": "RoomOwner",
"Marks": [
1000,
1002,
1003
],
"CustomInfo": ""
}
]
}
}

应答包字段说明

字段
类型
说明
ActionStatus
String
请求处理的结果,OK 表示处理成功,FAIL 表示失败
ErrorCode
Integer
错误码,0表示成功,非0表示失败
ErrorInfo
String
错误信息
RequestId
String
唯一请求 ID,每次请求都会返回,定位问题时需要提供该次请求的 RequestId
MemberList
Array
房间成员列表
Member_Account
String
房间成员 ID
NameCard
String
房间成员昵称
Role
String
房间成员权限:Owner(房主),Admin(管理员),Member(普通成员)
Marks
Array
房间成员标签
CustomInfo
String
房间成员自定义字段

错误码说明

除非发生网络错误(例如502错误),否则该接口的 HTTP 返回码均为200。真正的错误码,错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。 公共错误码(60000到79999)参见 错误码 文档。 本 API 私有错误码如下:
错误码
含义说明
100001
服务器内部错误,请重试
100002
请参数非法,请根据错误描述检查请求是否正确
100004
房间不存在,或者曾经存在过,但是目前已经被解散
100005
非房间成员
100006
操作权限不足