文档中心 即时通信 IM 服务端 API REST API 群组管理 查询用户在群组中的身份

查询用户在群组中的身份

最近更新时间:2019-08-02 18:10:07

功能说明

App 管理员可以通过该接口获取一批用户在群内的身份。

接口调用说明

适用的群组类型

群组类型 支持此REST API
私有群(Private)
公开群(Public)
聊天室(ChatRoom)
音视频聊天室(AVChatRoom) 否(见下方说明)
在线成员广播大群(BChatRoom) 否(见下方说明)

即时通信 IM 内置以上五种群组类型,详情请参阅 群组系统

说明:

  • 音视频聊天室不支持使用该 REST API 查询用户在群组中的身份,如果对这种群组进行操作将返回10007错误。如果管理员希望达到查询用户身份的效果,可以通过 获取群组成员详细资料 实现。
  • 在线成员广播大群不支持设置管理员和群主,全部成员都为普通成员。所以也不支持使用该 REST API 查询用户在群组中的身份。

请求 URL 示例

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

请求参数说明

下表仅列出调用本接口时涉及修改的参数及其说明,更多参数详情请参考 REST API 简介

参数 说明
v4/group_open_http_svc/get_role_in_group 请求接口
sdkappid 创建应用时即时通信 IM 控制台分配的 SDKAppID
identifier 必须为 App 管理员帐号,更多详情请参见 App 管理员
usersig App 管理员帐号生成的签名,具体操作请参见 生成 UserSig
random 请输入随机的32位无符号整数

最高调用频率

100次/秒。如需提升调用频率,请根据 工单模板 提交工单申请处理。

请求包示例

用来获取用户加入的群组,群组信息包含群 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 来表示的。
公共错误码(60000到79999)参见 错误码 文档。
本 API 私有错误码如下:

错误码 含义说明
10002 服务器内部错误,请重试
10003 请求命令字非法
10004 参数非法,请根据错误描述检查请求是否正确
10007 操作权限不足,例如 Public 群组中普通成员尝试执行踢人操作,但只有 App 管理员才有权限
10010 群组不存在,或者曾经存在过,但是目前已经被解散
10015 解析 JSON 包体失败,请检查包体的格式是否符合 JSON 格式

接口调试工具

通过 REST API在线调试工具 调试本接口。

参考

获取用户所加入的群组(v4/group_open_http_svc/get_joined_group_list)。