查询用户在群组中的身份
功能说明
App 管理员可以通过该接口获取一批用户在群内的身份，即“成员角色”。
接口调用说明
适用的群组类型
群组类型 ID | 是否支持此 REST API |
Private | 支持，同新版本中的 Work（好友工作群） |
Public | 支持 |
ChatRoom | 支持，同新版本中的 Meeting（临时会议群） |
AVChatRoom | 不支持 |
Community（社群） | 支持 |
说明
请求 URL 示例
https://xxxxxx/v4/group_open_http_svc/get_role_in_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json
请求参数说明
参数 | 说明 |
xxxxxx | SDKAppID 所在国家/地区对应的专属域名： 中国： console.tim.qq.com新加坡： adminapisgp.im.qcloud.com首尔： adminapikr.im.qcloud.com法兰克福： adminapiger.im.qcloud.com硅谷： adminapiusa.im.qcloud.com雅加达： adminapiidn.im.qcloud.com |
v4/group_open_http_svc/get_role_in_group | 请求接口 |
sdkappid | 创建应用时即时通信 Chat 控制台分配的 SDKAppID |
identifier | |
usersig | |
random | 请输入随机的32位无符号整数，取值范围0 - 4294967295 |
contenttype | 请求格式固定值为 json |
最高调用频率
200次/秒。
请求包示例
用来获取用户加入的群组，群组信息包含群 ID 和需要查询的群成员 ID。
{"GroupId": "@TGS#2C5SZEAEF","User_Account": [ // 最多支持500个"leckie","peter","wesley"]}
请求包字段说明
字段 | 类型 | 属性 | 说明 |
GroupId | String | 必填 | 需要查询的群组 ID |
User_Account | Array | 必填 | 表示需要查询的用户账号，最多支持500个账号 |
应答包体示例
{"ActionStatus": "OK","ErrorInfo": "","ErrorCode": 0,"UserIdList": [ // 结果{"Member_Account": "leckie","Role": "Owner" // 成员角色：Owner/Admin/Member/NotMember},{"Member_Account": "peter","Role": "Member"},{"Member_Account": "wesley","Role": "NotMember"}]}
应答包字段说明
字段 | 类型 | 说明 |
ActionStatus | String | 请求处理的结果，OK 表示处理成功，FAIL 表示失败 |
ErrorCode | Integer | 错误码，0表示成功，非0表示失败 |
ErrorInfo | String | 错误信息 |
UserIdList | Array | 拉取到的成员角色，包括：Owner（群主），Admin（群管理员），Member（普通群成员），NotMember（非群成员） |
错误码说明
除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为 200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
本 API 私有错误码如下：
错误码 | 含义说明 |
10002 | 服务器内部错误，请重试 |
10003 | 请求命令字非法 |
10004 | 参数非法，请根据错误描述检查请求是否正确 |
10007 | 操作权限不足，操作人必须为该群类型中有权限执行对应操作的成员角色 |
10010 | 群组不存在，或者曾经存在过，但是目前已经被解散 |
10015 | 解析 JSON 包体失败，请检查包体的格式是否符合 JSON 格式 |
