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

获取会话列表

GET
/chat/list
📌
使用场景
此接口用来批量拉取对应小组内的所有会话数据,因为数据量比较大,且系统内的数据库是读写分离的,因此这个接口拉取到的数据可能会有延迟不准确的情况,

请求参数

Query 参数

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://zan-api.xiaoshunai.com/chat/list?token=669dc78a7*****3e04351d6&iterator=686e4ed1bae448bf1f0ca055&pageSize=5'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "data": {
        "chats": [
            {
                "chatId": "686e4ed0b****bf1f0c9f47",
                "assigneeId": "",
                "botId": "686e4e9bd****f7b98919e69",
                "type": 0,
                "wxid": "78813****347451",
                "avatarUrl": "",
                "name": "test",
                "extraInfo": null,
                "contactType": 3,
                "coworker": false,
                "corporation": "测试科技",
                "externalUserId": "wmrRhyBgAAvw*****AoGkAYsUo6XzCQ"
            }
        ],
        "nextIterator": "686e4ecfbae448bf1f0c9ecf"
    }
}
修改于 2025-07-10 06:11:00
上一页
会话ai状态切换
下一页
会话事件回调
Built with