查询用户已加入的群组信息

描述

查询某个用户的已加入的群组信息。

接口原型

请求方法： POST
请求地址：https://zim-api.zego.im/?Action=QueryGroupsInfoOfUser
传输协议： HTTPS
调用频率限制： 20 次/秒。

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

参数	类型	是否必选	描述
FromUserId	String	是	查询的用户 Id 。
Limit	Number	是	每页返回的群组数量。取值范围为 [1, 100]。
Next	String	否	分页标识符。首次请求填写空字符串获取第一页，后续请求填写响应结果中 NextRsp 值获取下一页。

请求示例

{
  "FromUserId": "UserId123",
  "Limit": "2",
  "Next": ""
}

{
  "FromUserId": "UserId123",
  "Limit": "2",
  "Next": ""
}

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	返回状态信息信息。
RequestId	String	请求唯一标识。
NextRsp	String	下一页的分页拉取标识。如果为 0 表示没有更多数据。
HasJoinGroupNum	int64	用户已加入的群组数量。
GroupInfoList	Array Of Object	用户已加入的群组信息列表。

GroupInfoList 如下：

参数	类型	描述
GroupId	String	群组 Id。
GroupName	String	群组名。
GroupAvatar	String	群头像。

响应示例

{
    "Code": 0,
    "Message": "success",
    "RequestId": "req-123456789",
    "NextRsp": "3",
    "HasJoinGroupNum": 21,
    "GroupInfoList": [
        {
            "GroupId": "groupId1",
            "GroupName": "groupName1",
            "GroupAvatar": "GroupAvatar1",
        },
        {
            "GroupId": "groupId2",
            "GroupName": "groupName2",
            "GroupAvatar": "GroupAvatar2",
        }
    ]    
}

{
    "Code": 0,
    "Message": "success",
    "RequestId": "req-123456789",
    "NextRsp": "3",
    "HasJoinGroupNum": 21,
    "GroupInfoList": [
        {
            "GroupId": "groupId1",
            "GroupName": "groupName1",
            "GroupAvatar": "GroupAvatar1",
        },
        {
            "GroupId": "groupId2",
            "GroupName": "groupName2",
            "GroupAvatar": "GroupAvatar2",
        }
    ]    
}

返回码

以下仅列出了接口业务逻辑相关的返回码，完整返回码请参考全局返回码。

返回码	说明	解决方案
660000002	参数错误。	请检查参数。
660300005	频率限制。	请稍后再尝试。
660500002	操作者用户未注册。	请先注册请求的用户。