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/get
📌
使用场景
此接口适合在接收到某一个会话事件推送之后,当通过事件中的chatId找不到对应的会话信息时,调用此接口获取会话信息 因为这个事件大多数情况是建议在通过事件进行触发,因此这个接口有频率调用限制,当前限制为300次/30秒 如果有大批量获取会话数据的需求,请使用下面的获取会话列表接口

请求参数

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/get?token=669dc78a7*****3e04351d6&chatId=6810462536****23b2fe4f1b'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 0,
    "data": {
        "chatId": "6810462536****3b2fe4f1b",
        "assigneeId": "68624d38e2****865724dc12",
        "botId": "66a77970c9****6b879ef868",
        "type": 0,
        "wxid": "78813****9347451",
        "avatarUrl": "https://wx.qlogo.cn/mmhead/bVy2VQVTWzbt6h7DOt8RLLgW1O3WKurmfLQ8W7EQHIGvD2XDLyofYTaryeL9jQiadgQjb7SZPrxY/0",
        "name": "有人吗",
        "extraInfo": "f2",
        "contactType": 1,
        "coworker": false,
        "corporation": null,
        "externalUserId": "wmrRhyBgAAvwB*****oGkAYsUo6XzCQ"
    }
}
修改于 2025-07-18 09:51:35
上一页
获取会话ai状态
下一页
会话ai状态切换
Built with