@webitel/api-services
    Preparing search index...

    HistoryMessageCursorRequest represents a cursor-based pagination request for retrieving messages relative to a specific message ID.

    This request is used in keyset pagination, where the id field acts as a cursor pointing to a reference message in the history. The server returns messages either before or after this cursor depending on the before flag.

    Pagination semantics:

    • The id must be a valid UUID of an existing message.
    • The result set is always ordered consistently (e.g., by creation time).
    • The before flag controls the direction of traversal in the message history.

    Direction behavior:

    • before = true: Fetch messages that come before the given message in history (i.e., older messages).

    • before = false: Fetch messages that come after the given message (i.e., newer messages, moving toward the present).

    Notes:

    • This approach avoids offset-based pagination issues such as skipping or duplicating records when data changes.
    • Typically used for chat/message history scrolling.
    • The number of returned messages is controlled separately (e.g., via limit).
    interface WebitelImApiGatewayV1HistoryMessageCursorRequest {
        before?: boolean;
        id?: string;
    }
    Index

    Properties

    Properties

    before?: boolean

    Pagination direction flag.

    true -> fetch newer messages (back before history) false -> fetch older messages (back to older history)

    id?: string

    Cursor identifier. Must be a valid UUID referencing an existing message. Defines the starting point for pagination.