获取群列表信息

请求参数

Query 参数

current

string

可选

页码, 默认为0，即第一页

示例值:

0

pageSize

string

可选

每页数量, 默认为10，最大为100

示例值:

100

wxid

string

可选

需要搜索的群聊系统id，当传入此参数时，current 和 pageSize 失效

示例代码

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

返回响应

🟢200成功

application/json

Body

code

integer

必需

data

array [object {12}]

群数据

必需

chatId

string

该群组的对话id

可选

botInfo

object

所属托管账号信息

可选

wxid

string

群聊的系统id

可选

topic

string

群名称

可选

avatarUrl

string

群头像

可选

ownerId

string

群主的系统联系人id

可选

members

array [object {8}]

群成员列表信息

可选

labels

array [object {2}]

自定义标签信息

可选

wecomChatId

string

群聊企业微信id

可选

deleted

boolean

群聊是否已经不在

可选

external

boolean

可选

群聊 true外部群聊 false内部群聊

memberCount

integer

群成员人数

可选

page

object

必需

current

integer

当前页数

必需

total

integer

总数

必需

示例

{
    "code": 0,
    "data": [
        {
            "chatId": "string",
            "botInfo": {
                "wxid": "string",
                "weixin": "string",
                "nickName": "string"
            },
            "wxid": "string",
            "topic": "string",
            "avatarUrl": "string",
            "ownerId": "string",
            "members": [
                {
                    "wxid": "string",
                    "nickName": "string",
                    "avatarUrl": "string",
                    "roomAlias": "string",
                    "isFriend": true,
                    "contactType": 0,
                    "coworker": true,
                    "corporation": "string"
                }
            ],
            "labels": [
                {
                    "id": "string",
                    "name": "string"
                }
            ],
            "wecomChatId": "string",
            "deleted": true,
            "external": true,
            "memberCount": 0
        }
    ],
    "page": {
        "current": 0,
        "total": 0
    }
}