检索历史消息 - 即时通信

该接口可以根据 Thread 根消息分页查询 Thread 消息列表（包括单聊消息，高级群消息和超大群消息）。

请求参数

Query 参数

operator_id

string

操作者账号 ID。

必需

conversation_id

string

可选

需要搜索的会话 ID。若不填，则默认搜索全部会话。会话 ID 需要用户自行拼装，拼装规则：
sender_id|conversation_type|receiver_id 或 sender_id|conversation_type|team_id
发送者账号 ID
conversation_type：会话类型，1：单聊会话；2：高级群会话
receiver_id：接收者账号 ID（单聊对话）
team_id：群组 ID（群组会话）

sender_account_ids

string

可选

根据消息发送者检索消息，发送者之间用 , 分割，最多支持 5 个，超过将返回参数错误。

message_types

string

可选

根据消息类型检索消息，消息类型之间 , 分割。若不填，则默认检索所有消息类型。
支持的消息类型包括：0：文本；1：图片；2：语音；3：视频；4：地理位置；5：通知；6：文件；10：提示；11：Robot；100：自定义。

message_sub_types

string

可选

根据消息子类型检索消息，消息子类型之间 , 分割。若不填，则默认检索所有消息子类型。

start_time

number

可选

检索的起始时间点，UTC 时间戳，单位为毫秒。若未设置，默认为当前时间点。

time_period

number

可选

从起始时间点开始的过去时间范围，单位为毫秒。若未设置表示不限制时间范围。
24x60x60x1000=86400000 表示 1 天。

keyword_list

array[string]

可选

根据关键词检索消息，JSONArray 格式字符串，最多支持 5 个关键词。

示例值:

[""]

keyword_match_type

integer

可选

关键词匹配类型，0：或关系搜索；1：与关系搜索。

page_token

string

可选

分页标识符，如果为空，则从第一页开始查询。后续传入返回的 next_token。

limit

integer

可选

本次检索消息条数上限，最多 100 条。小于等于 0，或者大于 100 会提示参数错误。

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 数据对象，请求失败则返回空对象。

count

integer

搜索到的消息数量。

必需

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