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

    Interface ListContactsRequestData

    interface ListContactsRequestData {
        channel?: string;
        external_id?: string;
        identity?: string;
        page_size?: number;
        page_token?: string;
    }
    Index

    Properties

    channel? external_id? identity? page_size? page_token?

    Properties

    channel?: string

    Optional. Specifies a channel, and must be set to one of the enum values. If set, the identity parameter must be set and external_id can't be used. Used in conjunction with identity to uniquely identify the specified channel identity.

    external_id?: string

    Optional. Contact identifier in an external system. If used, channel and identity query parameters can't be used.

    identity?: string

    Optional. If set, the channel parameter must be set and external_id can't be used. Used in conjunction with channel to uniquely identify the specified channel identity. This will differ from channel to channel. For example, a phone number for SMS, WhatsApp, and Viber Business.

    Optionalpage_size

    page_size?: number

    Optional. The maximum number of contacts to fetch. The default is 10 and the maximum is 20.

    Optionalpage_token

    page_token?: string

    Optional. Next page token previously returned if any.

    Settings

    Member Visibility

    On This Page

    Properties