API接口文档 (小组级)-新
  1. 基础接口
API接口文档 (小组级)-新
  • api接入说明
  • 系统使用说明
  • 接口文档
    • 小组级接口
      • 小组级接口说明
      • 基础接口
        • 获取托管账号列表
          GET
        • 获取联系人列表
          GET
        • 获取群列表
          GET
        • 获取群列表(不包含成员信息)
          GET
        • 发送系统通知
          POST
        • 获取自定义标签列表
          GET
        • 获取组内员工列表
          GET
      • 群聊接口
        • 加入群聊
        • 退出群聊事件回调
        • 加入群聊事件回调
        • 更改群名事件回调
        • 创建群聊
        • 通过联系人id获取联系人所在群聊
      • 会话接口
        • 开发建议
        • 会话超时跟进回调
        • 获取会话ai状态
        • 获取指定会话
        • 会话ai状态切换
        • 获取会话列表
        • 会话事件回调
        • 分配会话
        • 消息置顶
      • 加好友接口
        • 通过手机号加好友接口
        • api加好友任务成功回调
        • 好友通过后回调
        • 群聊加好友接口
      • 消息接口
        • 小组级发送消息回调
        • 获取原图
        • 发送消息
        • 小组级接收消息回调
        • 聊天历史
        • im员工id发消息
      • 群发接口
        • 创建群发
        • 重发群发
        • 取消群发
        • 删除群发
        • 群发回调
        • 获取群发任务的失败列表
        • 获取群发任务的没有发送的列表
        • 获取群发任务的进度
    • 自建应用依赖接口
      • 客户信息接口
        • 修改客户备注
        • 添加跟进记录
      • 雷达接口
        • 雷达访问接口
      • id信息获取接口
        • 通过unionId获取chatId
    • 废弃接口
      • 会话小结
      • 渠道二维码管理
        • 获取渠道列表(企业控制台数据)
      • 通过im群聊id加好友
      • 新增客户
      • 获取成员详情
      • 秒回数据同步
      • 获取群列表
      • 获取客户详情
      • 获取群信息
      • 绑定im官方ID
      • 通过externalUserId获取chatId
  1. 基础接口

获取群列表

GET
/room/list

请求参数

Query 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location -g --request GET 'https://zan-api.xiaoshunai.com/room/list?token={{org_token}}&current=1&pageSize=5&wxid=R:1087943******8483'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "data": [
        {
            "avatarUrl": "https://workzen.s3.cn-northwest-1.amazonaws.com.cn/room_avatar/a019056c-1769-4df5-a6e6-b21a8af7cb2f/10938114619992942.png",
            "botId": "683e6198e*****973fe991ac",
            "topic": "test群聊",
            "ownerId": "168885****496582",
            "memberCount": 4,
            "deleted": false,
            "wxid": "R:109381*****992942",
            "external": true,
            "wecomChatId": "",
            "groupId": "64758f0211*****9615998f1",
            "members": [
                {
                    "wxid": "16888****741547",
                    "nickName": "Android Apple Phone Test A",
                    "avatarUrl": "https://wework.qpic.cn/wwpic3az/190641_ejXiO-swQUuPBF6_1747385282/0",
                    "roomAlias": "test",
                    "isFriend": true,
                    "coworker": true,
                    "contactType": 3,
                    "corporation": "test科技",
                    "joinTime": 1747296818,
                    "joinScene": 1,
                    "inviterId": "168885*****96582"
                }
            ],
            "labels": [],
            "chatId": "686e1d01ba*****f1ff058b6",
            "botInfo": {
                "wxid": "16888****741547",
                "weixin": "zhangsan",
                "nickName": "Android Apple Phone Test A"
            }
        }
    ],
    "page": {
        "current": 1,
        "total": 931
    }
}
修改于 2025-12-23 02:50:37
上一页
获取联系人列表
下一页
获取群列表(不包含成员信息)
Built with