获取历史消息的参数。

interface GetHistoryMessagesParams {
    cursor?: string;
    pageSize?: number;
    searchDirection?: "up" | "down";
    senderIds?: readonly string[];
    messageTypes?: readonly MessageType[];
    startTime?: number;
    endTime?: number;
    conversationId: string;
    conversationType: "singleChat" | "groupChat" | "chatRoom";
}

Hierarchy (View Summary)

Properties

cursor?: string

开始获取数据的游标位置。首次调用时传空字符串或 null,SDK 会按 searchDirection 参数的值拉取消息。服务器返回的数据中包含 cursor 字段,需保存在本地;后续调用该接口时,可传入最新的 cursor 作为下一次获取数据的起始位置。

pageSize?: number

每页返回的消息数量。

searchDirection?: "up" | "down"

拉取方向。up 表示拉取更早的消息,down 表示拉取更新的消息。

senderIds?: readonly string[]

按发送者过滤,仅在群聊场景下生效。

messageTypes?: readonly MessageType[]

按消息类型过滤。

startTime?: number

查询起始时间戳,单位为毫秒。

endTime?: number

查询结束时间戳,单位为毫秒。

conversationId: string

会话 ID。

conversationType: "singleChat" | "groupChat" | "chatRoom"

会话类型。