API接口文档

获取群列表

GET

https://aa-hub.ddregion.com/api/v2/groupChat/list

功能说明：

通过本接口可以获取企业下所有群聊信息列表并可以获取指定托管账号所在的群聊列表

群聊列表中包含：企业微信群聊ID（wecomChatId）、群名称、群主ID、创建时间、群公告、群标签、群成员ID、成员类型、加群方式、加群时间、群聊总数、系统群ID（imRoomid）

请求参数

Query 参数

token

string

必需

current

string

当前页数，不能为0

可选

pageSize

string

可选

每页数据条数（页数上限为100）

imBotId

string

托管账号系统id

可选

wecomUserId

string

可选

托管账号企微员工id

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://aa-hub.ddregion.com/api/v2/groupChat/list?token=&current=&pageSize=&imBotId=&wecomUserId='

返回响应

🟢200成功

application/json

Body

errcode

integer

错误码

必需

errmsg

string

错误描述

必需

data

array [object {7}]

必需

wecomChatId

string

客户群id

可选

name

string

群名

可选

owner

string

群主id

可选

createTime

integer

创建时间

可选

notice

string

群公告

可选

systemTag

array [object {3}]

必需

memberList

array [object {6}]

群成员id

可选

total

integer

总群聊数

必需

imRoomid

string

必需

示例

{
  "errcode": 0,
  "errmsg": "string",
  "data": [
    {
      "wecomChatId": "string",
      "name": "string",
      "owner": "string",
      "createTime": 0,
      "notice": "string",
      "systemTag": [
        {
          "groupName": "string",
          "tagName": "string",
          "tagId": "string"
        }
      ],
      "memberList": [
        {
          "type": 0,
          "imContactId": "string",
          "externalUserId": "string",
          "joinTime": 0,
          "joinScene": 0,
          "corpName": "string"
        }
      ]
    }
  ],
  "total": 0,
  "imRoomid": "string"
}

应用防骚扰策略

获取群二维码