查询 Thread 消息 - 即时通信

该接口可以根据 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

必需

默认值:

X-custom-traceid

string

可选

默认值:

{% mock 'uuid' %}

Nonce

string

必需

默认值:

CurTime

string

必需

默认值:

CheckSum

string

必需

默认值:

示例代码

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

返回响应

🟢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服务器错误