Sinch Node.js SDK - v1.5.0
    Preparing search index...

    Interface ListMessagesRequestData

    interface ListMessagesRequestData {
        app_id?: string;
        channel?: string;
        channel_identity?: string;
        contact_id?: string;
        conversation_id?: string;
        direction?: string;
        end_time?: Date;
        messages_source?: string;
        only_recipient_originated?: boolean;
        page_size?: number;
        page_token?: string;
        start_time?: Date;
        view?: string;
    }
    Index

    Properties

    app_id? channel? channel_identity? contact_id? conversation_id? direction? end_time? messages_source? only_recipient_originated? page_size? page_token? start_time? view?

    Properties

    app_id?: string

    Id of the app.

    channel?: string

    Only fetch messages from the channel.

    channel_identity?: string

    Channel identity of the contact.

    contact_id?: string

    Resource name (ID) of the contact.

    conversation_id?: string

    Resource name (ID) of the conversation.

    direction?: string

    Optional. Only fetch messages with the specified direction. If direction is not specified, it will list both TO_APP and TO_CONTACT messages.

    end_time?: Date

    Filter messages with accept_time before this timestamp.

    messages_source?: string

    Specifies the message source for which the request will be processed. Used for operations on messages in Dispatch Mode. For more information, see Processing Modes.

    only_recipient_originated?: boolean

    If true, fetch only recipient originated messages. Available only when messages_source is DISPATCH_SOURCE.

    Optionalpage_size

    page_size?: number

    Maximum number of messages to fetch. Defaults to 10 and the maximum is 1000.

    Optionalpage_token

    page_token?: string

    Next page token previously returned if any. When specifying this token, make sure to use the same values for the other parameters from the request that originated the token, otherwise the paged results may be inconsistent.

    start_time?: Date

    Filter messages with accept_time after this timestamp. Must be before end_time if that is specified.

    view?: string

    Settings

    Member Visibility

    On This Page

    Properties