Azure Connectors Node.js SDK
    Preparing search index...

    Options for the getContacts operation.

    interface GetContactsOptions {
        abortSignal?: AbortSignalLike;
        contactCreatedAfter?: string;
        contactCreatedBefore?: string;
        contactPhoneNumber?: string;
        customFieldId1?: string;
        customFieldId2?: string;
        customFieldId3?: string;
        customFieldValue1?: string;
        customFieldValue2?: string;
        customFieldValue3?: string;
        groups?: string;
        hasOptedOut?: boolean;
        isArchived?: boolean;
        isBlocked?: boolean;
        isResolved?: boolean;
        isSuppressed?: boolean;
        lastMessageReceivedAfter?: string;
        lastMessageReceivedBefore?: string;
        lastMessageSentAfter?: string;
        lastMessageSentBefore?: string;
        lastMessageTimestampAfterUtc?: string;
        lastMessageTimestampBeforeUtc?: string;
        onResponse?: ConnectorRawResponseCallback;
        tags?: string;
        tracingOptions?: OperationTracingOptions;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignalLike

    Signal used to cancel the operation.

    contactCreatedAfter?: string

    Cutoff time for searching contacts by when they were created. No contacts created before this time will be shown.

    contactCreatedBefore?: string

    Cutoff time for searching contacts by when they were created. No contacts created after this time will be shown.

    contactPhoneNumber?: string

    Phone number to filter contacts by.

    customFieldId1?: string

    Guid referring to custom field to filter contacts by.

    customFieldId2?: string

    Guid referring to second custom field to filter contacts by.

    customFieldId3?: string

    Guid referring to third custom field to filter contacts by.

    customFieldValue1?: string

    Value referring to custom field to filter contacts by.

    customFieldValue2?: string

    Value referring to second custom field to filter contacts by.

    customFieldValue3?: string

    Value referring to third custom field to filter contacts by.

    groups?: string

    Comma-separated list of integer ids referring to groups to filter contacts by.

    hasOptedOut?: boolean

    Whether to search for contacts who have opted out of receiving texts.

    isArchived?: boolean

    Whether to search for contacts who have been archived.

    isBlocked?: boolean

    Whether to search for contacts who have been blocked.

    isResolved?: boolean

    Whether to search for contacts whose conversations have been resolved.

    isSuppressed?: boolean

    Whether to search for contacts who have been suppressed.

    lastMessageReceivedAfter?: string

    Cutoff time for searching contacts by the last message received from the customer. No contacts whose last sent message is before this time will be shown. Uses timestamp as local time. To filter by time stamp in UTC time, use last_message_sent_before_utc

    lastMessageReceivedBefore?: string

    Cutoff time for searching contacts by the last message received from the customer. No contacts who received messages after this time will be shown. Uses timestamp as local time. To filter by time stamp in UTC time, use last_message_sent_before_utc

    lastMessageSentAfter?: string

    Cutoff time for searching contacts by when the last message was sent to the customer. No contacts whose last sent message is before this time will be shown. Uses timestamp as local time. To filter by time stamp in UTC time, use last_message_sent_after_utc

    lastMessageSentBefore?: string

    Cutoff time for searching contacts by when the last message was sent to the customer. No contacts who sent messages after this time will be shown. Uses timestamp as local time. To filter by time stamp in UTC time, use last_message_sent_before_utc

    lastMessageTimestampAfterUtc?: string

    Cutoff time for searching contacts by the last message sent or received. No contacts whose last sent message is before this time will be shown.

    lastMessageTimestampBeforeUtc?: string

    Cutoff time for searching contacts by the last message sent or received. No contacts who sent messages after this time will be shown.

    Callback invoked with the complete response before the operation returns or throws.

    tags?: string

    Comma-separated list of guids referring to tags to filter contacts by.

    tracingOptions?: OperationTracingOptions

    Context used to parent the operation's tracing span.