即时通信
  1. 消息管理
即时通信
  • API在线调试指南
  • IM账号管理
    • 注册云信IM账号
      POST
    • 更新账号属性
      PATCH
    • 刷新 Token
      PATCH
    • 封禁账号
      PATCH
    • 更新移动端推送配置
      PATCH
    • 查询账号属性
      GET
    • 批量查询账号信息
      GET
    • 强制账号退出登录
      POST
  • 用户名片管理
    • 更新用户名片
    • 查询用户名片
    • 批量查询用户名片
    • 批量获取账号在线状态
  • 好友管理
    • 添加好友
    • 删除好友
    • 更新好友信息
    • 查询好友信息
    • 分页查询好友列表
    • 同意/拒绝添加好友
  • 静音管理
    • 分页查询静音列表
    • 解除静音
    • 设置静音
  • 黑名单管理
    • 列入黑名单
    • 移出黑名单
    • 分页查询黑名单列表
  • 消息管理
    • 发送消息
      POST
    • 批量发送单聊消息
      POST
    • 撤回/删除消息
      DELETE
    • 删除会话中漫游/历史消息
      DELETE
    • 发送单聊已读回执
      POST
    • 发送高级群已读回执
      POST
    • 查询群消息已读未读详情
      GET
    • 查询单条消息
      GET
    • 分页查询历史消息
      GET
    • 发送聊天室消息
      POST
    • 批量发送聊天室消息
      POST
    • 撤回/删除聊天室历史消息
      DELETE
    • 分页查询聊天室历史消息
      GET
    • 更新消息
      POST
    • 根据消息 ID 查询历史消息
      POST
    • 查询 Thread 消息
      GET
    • 添加快捷评论
      PATCH
    • 删除快捷评论
      DELETE
    • 查询快捷评论
      POST
    • 检索历史消息
      GET
    • 发送流式消息
      POST
  • 会话功能
    • 会话管理
      • 创建会话
      • 更新会话
      • 删除会话
      • 批量删除会话
      • 查询会话信息
      • 批量查询会话信息
      • 分页查询账号的所有会话列表
    • 会话未读数管理
      • 获取会话总未读数
    • 会话分组
      • 创建会话分组
      • 更新会话分组
      • 删除会话分组
      • 查询会话分组信息
      • 批量查询会话分组信息
      • 查询所有会话分组信息
  • 群组功能
    • 群成员
      • 拉人入群
      • 踢人出群
      • 主动退群
      • 更新群成员信息
      • 批量禁言群成员
      • 分页查询指定账号已加入的群组信息
    • 群组管理
      • 创建群组
      • 更新群组信息
      • 转让群主
      • 添加管理员
      • 移除管理员
      • 解散群组
      • 查询群组信息
      • 批量查询群组信息列表
      • 查询高级群在线成员列表
      • 批量查询高级群的在线成员数
      • 分页查询群成员列表
  • 聊天室功能
    • 聊天室管理
      • 创建聊天室
      • 获取聊天室地址
      • 查询聊天室信息
      • 更新聊天室信息
      • 开放/关闭聊天室
      • 聊天室禁言
      • 开启/关闭进出聊天室事件通知
      • 查询开放状态的聊天室
      • 分页查询聊天室在线成员列表
      • 查询聊天室固定成员列表
    • 聊天室成员
      • 设置聊天室成员角色
      • 更新聊天室在线成员信息
      • 禁言聊天室成员
      • 临时禁言聊天室成员
      • 查询聊天室的禁言列表
      • 拉黑聊天室成员
      • 聊天室标签禁言
      • 查询聊天室黑名单列表
      • 聊天室标签禁言
      • 修改聊天室在线成员标签
      • 查询标签下的在线成员数
      • 分页查询标签下的在线成员列表
      • 批量查询聊天室固定成员信息
      • 添加聊天室虚构用户
      • 删除聊天室虚构用户
      • 清空聊天室虚构用户
      • 查询聊天室虚构用户
    • 聊天室队列
      • 初始化聊天室队列
      • 删除聊天室队列
      • 更新聊天室队列
      • 查询聊天室队列元素
      • 从聊天室队列中取出元素
  • 广播消息管理
    • 发送广播消息
    • 删除广播消息
    • 查询广播消息
    • 分页查询广播消息
    • 发送聊天室全服广播消息
  • 系统通知管理
    • 发送自定义系统通知
    • 批量发送自定义系统通知
  • 发布订阅
    • 订阅在线状态事件
    • 查询在线状态事件订阅关系
    • 取消在线状态事件订阅
  • 翻译
    • 文本翻译
  1. 消息管理

查询 Thread 消息

GET
/im/v2/messages/actions/thread_messages
该接口可以根据 Thread 根消息分页查询 Thread 消息列表(包括单聊消息,高级群消息和超大群消息)。

请求参数

Query 参数
begin_time
number 
必需
查询开始时间(毫秒)。
end_time
number 
必需
查询截止时间(毫秒)。
page_token
string 
可选
分页标识符,如果为空,则从第一页开始查询。
limit
integer 
必需
每页返回的消息数上限,最大为 100。小于等于 0,或者大于 100,会报 414 错误。
descending
boolean 
可选
是否按时间正序,true:按时间正序。false:按时间倒序。
conversation_type
string 
必需
Thread 根消息的会话类型。1:单聊。2:高级群。3:超大群。
operator_id
string 
必需
进行查询的操作者账号 ID。
sender_id
string 
必需
Thread 根消息的发送者。
receiver_id
string 
必需
Thread 根消息的接收者。
message_server_id
number 
必需
Thread 根消息的服务器 ID。
message_client_id
string 
必需
Thread 根消息的客户端 ID。
create_time
number 
必需
Thread 根消息的发送时间(毫秒)。
Header 参数
AppKey
string 
必需
默认值:
{{AppKey}}
X-custom-traceid
string 
可选
默认值:
{% mock 'uuid' %}
Nonce
string 
必需
默认值:
{{Nonce}}
CurTime
string 
必需
默认值:
{{CurTime}}
CheckSum
string 
必需
默认值:
{{CheckSum}}

示例代码

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://open.yunxinapi.com/im/v2/messages/actions/thread_messages?begin_time&end_time&page_token&limit&descending&conversation_type&operator_id&sender_id&receiver_id&message_server_id&message_client_id&create_time' \
--header 'AppKey;' \
--header 'X-custom-traceid: {% mock '\''uuid'\'' %}' \
--header 'Nonce;' \
--header 'CurTime;' \
--header 'CheckSum;'

返回响应

🟢200成功
application/json
Body
code
integer 
必需
状态码,200 表示请求成功。
msg
string 
必需
提示信息。请求失败时返回错误信息,请求成功时返回 "success"。
data
object 
必需
返回的 JSON 数据对象,请求失败则返回空对象。
has_more
boolean 
是否还有更多数据。
必需
next_token
string 
分页标识符。
可选
thread_root
object 
必需
Thread 根消息对象。
示例
{
    "code": 0,
    "msg": "string",
    "data": {
        "has_more": true,
        "next_token": "string",
        "thread_root": {
            "message_server_id": 0,
            "sender_id": "string",
            "message_type": 0,
            "create_time": 0,
            "message_client_id": "string",
            "sender_client_type": 0,
            "text": "string",
            "attachment": {},
            "extension": "string",
            "team_id": 0,
            "receiver_id": "string",
            "sub_type": 0,
            "modify_account_id": "string",
            "modify_time": 0,
            "thread_config": {
                "thread_root": {
                    "sender_id": "string",
                    "receiver_id": "string",
                    "create_time": 0,
                    "message_server_id": "string",
                    "message_client_id": "string"
                },
                "thread_reply": {
                    "sender_id": "string",
                    "receiver_id": "string",
                    "create_time": 0,
                    "message_server_id": 0,
                    "message_client_id": 0
                }
            },
            "total": true,
            "timestamp": 0,
            "messages": [
                {
                    "message_server_id": 0,
                    "sender_id": "string",
                    "message_type": 0,
                    "create_time": 0,
                    "message_client_id": "string",
                    "sender_client_type": 0,
                    "text": "string",
                    "attachment": {},
                    "extension": "string",
                    "team_id": 0,
                    "receiver_id": "string",
                    "sub_type": 0,
                    "modify_account_id": "string",
                    "modify_time": 0,
                    "thread_config": {
                        "thread_root": {
                            "sender_id": "string",
                            "receiver_id": "string",
                            "create_time": 0,
                            "message_server_id": "string",
                            "message_client_id": "string"
                        },
                        "thread_reply": {
                            "sender_id": "string",
                            "receiver_id": "string",
                            "create_time": 0,
                            "message_server_id": 0,
                            "message_client_id": 0
                        }
                    }
                }
            ]
        }
    }
}
🟢200成功
🟢200请求参数错误
🟢200服务器错误
上一页
根据消息 ID 查询历史消息
下一页
添加快捷评论
Built with