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

    Interface ListLastMessagesByChannelIdentityRequest

    Request body for listing messages by channel identity. NOTE: You can use either contact_ids OR channel_identities, but not both in the same request.

    interface ListLastMessagesByChannelIdentityRequest {
        app_id?: string;
        channel?: string;
        channel_identities?: string[];
        contact_ids?: string[];
        direction?: string;
        end_time?: Date;
        messages_source?: string;
        page_size?: number;
        page_token?: string;
        start_time?: Date;
        view?: string;
    }
    Index

    Properties

    app_id? channel? channel_identities? contact_ids? direction? end_time? messages_source? page_size? page_token? start_time? view?

    Properties

    app_id?: string

    Optional. Resource name (id) of the app.

    channel?: string

    Optional. Only fetch messages from the channel.

    channel_identities?: string[]

    Optional. Filter messages by channel_identity.

    contact_ids?: string[]

    Optional. Resource name (id) of the contact. In case the messages source is set to CONVERSATION_SOURCE: Can list last messages by contact_id. In case the messages source is set to DISPATCH_SOURCE: The field is unsupported and cannot be set.

    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

    Optional. Only fetch messages with accept_time before this timestamp.

    messages_source?: string

    Optional. Specifies the message source for which the request will be processed. Default is DISPATCH_SOURCE.

    Optionalpage_size

    page_size?: number

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

    Optionalpage_token

    page_token?: string

    Optional. Next page token previously returned if any.

    start_time?: Date

    Optional. Only fetch messages with accept_time after this timestamp.

    view?: string

    Optional. Specifies the representation in which messages should be returned. Default to WITH_METADATA.

    Settings

    Member Visibility

    On This Page

    Properties