tencent cloud

功能说明

App 管理员可以通过该接口获取一批用户在群内的身份，即“成员角色”。

接口调用说明

适用的群组类型

即时通信 IM 内置上述群组类型，详情请参阅 群组系统。

说明：

AVChatRoom（直播群）不支持该接口，对此类型群组进行操作将返回10007错误；但可以通过 获取群组成员详细资料 达到查询“成员角色”的效果。

请求 URL 示例

https://xxxxxx/v4/group_open_http_svc/get_role_in_group?sdkappid=88888888&identifier=admin&usersig=xxx&random=99999999&contenttype=json

请求参数说明

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

最高调用频率

200次/秒。

请求包示例

用来获取用户加入的群组，群组信息包含群 ID 和需要查询的群成员 ID。

{
    "GroupId": "@TGS#2C5SZEAEF",
    "User_Account": [ // 最多支持500个
        "leckie",
        "peter",
        "wesley"
    ]
}

请求包字段说明

应答包体示例

{
    "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"
        }
    ]
}

应答包字段说明

错误码说明

除非发生网络错误（例如502错误），否则该接口的 HTTP 返回码均为 200。真正的错误码，错误信息是通过应答包体中的 ErrorCode、ErrorInfo 来表示的。
公共错误码（60000到79999）参见 错误码 文档。
本 API 私有错误码如下：

接口调试工具

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

参考

获取用户所加入的群组（v4/group_open_http_svc/get_joined_group_list）