API 参考
在线调试

分页查询账号的所有会话列表

更新时间: 2024/07/17 16:54:49

功能描述

该接口可以分页查询指定账号的所有会话列表

  • 历史会话最多可查询 1 万条,建议分页获取,每页最多查询 100 条会话信息。
  • 置顶会话排在最前。

调用频率

单个应用默认最高调用频率请参考 频控说明

请求

URL

GET https://open.yunxinapi.com/im/v2/conversations

请求 Header 的参数说明请参见请求 Header

查询参数

参数名称 类型 是否必选 描述
account_id String 必选 发起查询操作的云信账号。
page_token String 可选 分页标识符,如果为空,则从第一页开始查询。
limit Integer 可选 每页返回的会话数,最大为 100。若传入小于等于 0 的数,默认为 100。

响应

Header

响应 Header 的参数说明请参见响应 Header

响应体参数

参数名称 类型 描述 是否必返回
code Integer 状态码,200 表示请求成功。
msg String 提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data Object 返回的 JSON 数据对象,请求失败则返回空对象。

响应体示例

json{
    "code": 200,
    "msg": "success",
    "data": {
        "items": [
            {
                "conversation_id": "Accid1|1|Accid2",
                "type": 1,
                "stick_top": true,
                "group_ids": [1, 2, 3],
                "server_extension": "extension",
                "unread_count": 0,
                "sort_order": 1,
                "create_time": 1,
                "update_time": 1
            },
            {
                
            }
        ],
        "next_token": "abcd",
        "has_more": true
    }
}

错误码

错误码 错误码描述 错误信息示例
200 请求成功 success
414 参数错误 parameter error
102404 用户不存在 account not exist
500 服务器内部错误 internal server error
此文档是否对你有帮助?
有帮助
去反馈
  • 功能描述
  • 调用频率
  • 请求
  • URL
  • Header
  • 查询参数
  • 响应
  • Header
  • 响应体参数
  • 响应体示例
  • 错误码