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

    Interface GetConversationsOptions

    Options for the getConversations operation.

    interface GetConversationsOptions {
        abortSignal?: AbortSignalLike;
        includeArchived?: string;
        onResponse?: ConnectorRawResponseCallback;
        page?: number;
        pageSize?: number;
        search?: string;
        showUnresolvedOnly?: string;
        tags?: string;
        tracingOptions?: OperationTracingOptions;
    }

    Hierarchy (View Summary)

    Index
    abortSignal?: AbortSignalLike

    Signal used to cancel the operation.

    includeArchived?: string

    Whether to include conversations with contacts that have been archived.

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

    page?: number

    The page of entities to get. When getting values, there is a max size per page, defined by page_size. If page is greater than the last page, an empty array will be returned.

    pageSize?: number

    The size of each page to get. When getting values, this is a max size per page, with accessing subsequent pages done by the page parameter.

    search?: string

    Search term for filtering conversations by phone number or display name. If the search term is less than a full name or phone number, the search will return all conversations that partially match it.

    showUnresolvedOnly?: string

    Whether to only search for contacts whose conversations have been resolved. If this is false, both resolved and unresolved conversations will be shown.

    tags?: string

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

    tracingOptions?: OperationTracingOptions

    Context used to parent the operation's tracing span.