TextRequestClient.GetContactsAsync Method

Definition

Namespace:: Azure.Connectors.Sdk.TextRequest

Assembly:: Azure.Connectors.Sdk.dll

Package:: Azure.Connectors.Sdk v0.13.0-preview.1

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Get all contacts that match the specified filtering criterion

public virtual System.Threading.Tasks.Task<Azure.Connectors.Sdk.TextRequest.Models.GetContactsResponse> GetContactsAsync(int idOfTheDashboardToMakeThisCallOn, int numberPageToGet, int amountOfEachEntityToGetPerPage, string contactSPhoneNumberToSearchBy = default, string lastMessageTimeSentBeforeSearchTimestampInUTCTime = default, string lastMessageTimeSentAfterSearchTimestampInUTCTime = default, string createdBeforeSearchTimestamp = default, string createdAfterSearchTimestamp = default, bool? whetherContactSConversationIsResolved = default, bool? whetherContactIsBlocked = default, bool? whetherContactIsArchived = default, bool? whetherContactIsSuppressed = default, bool? whetherContactHasOptedOut = default, string lastMessageTimeSentBeforeSearchTimestamp = default, string lastMessageTimeSentAfterSearchTimestamp = default, string lastMessageTimeReceivedBeforeSearchTimestamp = default, string lastMessageTimeReceivedAfterSearchTimestamp = default, string contactTags = default, string contactGroups = default, string idOfCustomFieldToFilterBy = default, string valueOfCustomFieldToFilterBy = default, string idOfSecondCustomFieldToFilterBy = default, string valueOfSecondCustomFieldToFilterBy = default, string idOfThirdCustomFieldToFilterBy = default, string valueOfThirdCustomFieldToFilterBy = default, System.Threading.CancellationToken cancellationToken = default);

abstract member GetContactsAsync : int * int * int * string * string * string * string * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * string * string * string * string * string * string * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.TextRequest.Models.GetContactsResponse>
override this.GetContactsAsync : int * int * int * string * string * string * string * string * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * Nullable<bool> * string * string * string * string * string * string * string * string * string * string * string * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<Azure.Connectors.Sdk.TextRequest.Models.GetContactsResponse>

Public Overridable Function GetContactsAsync (idOfTheDashboardToMakeThisCallOn As Integer, numberPageToGet As Integer, amountOfEachEntityToGetPerPage As Integer, Optional contactSPhoneNumberToSearchBy As String = Nothing, Optional lastMessageTimeSentBeforeSearchTimestampInUTCTime As String = Nothing, Optional lastMessageTimeSentAfterSearchTimestampInUTCTime As String = Nothing, Optional createdBeforeSearchTimestamp As String = Nothing, Optional createdAfterSearchTimestamp As String = Nothing, Optional whetherContactSConversationIsResolved As Nullable(Of Boolean) = Nothing, Optional whetherContactIsBlocked As Nullable(Of Boolean) = Nothing, Optional whetherContactIsArchived As Nullable(Of Boolean) = Nothing, Optional whetherContactIsSuppressed As Nullable(Of Boolean) = Nothing, Optional whetherContactHasOptedOut As Nullable(Of Boolean) = Nothing, Optional lastMessageTimeSentBeforeSearchTimestamp As String = Nothing, Optional lastMessageTimeSentAfterSearchTimestamp As String = Nothing, Optional lastMessageTimeReceivedBeforeSearchTimestamp As String = Nothing, Optional lastMessageTimeReceivedAfterSearchTimestamp As String = Nothing, Optional contactTags As String = Nothing, Optional contactGroups As String = Nothing, Optional idOfCustomFieldToFilterBy As String = Nothing, Optional valueOfCustomFieldToFilterBy As String = Nothing, Optional idOfSecondCustomFieldToFilterBy As String = Nothing, Optional valueOfSecondCustomFieldToFilterBy As String = Nothing, Optional idOfThirdCustomFieldToFilterBy As String = Nothing, Optional valueOfThirdCustomFieldToFilterBy As String = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of GetContactsResponse)

Parameters

idOfTheDashboardToMakeThisCallOn: Int32

Id of the dashboard to make this call on

numberPageToGet: Int32

Number page to get

amountOfEachEntityToGetPerPage: Int32

Amount of each entity to get per page

contactSPhoneNumberToSearchBy: String

Contact's phone number to search by

lastMessageTimeSentBeforeSearchTimestampInUTCTime: String

'Last-message-time sent before' search timestamp in UTC time

lastMessageTimeSentAfterSearchTimestampInUTCTime: String

'Last-message-time sent after' search timestamp in UTC time

createdBeforeSearchTimestamp: String

'Created before' search timestamp

createdAfterSearchTimestamp: String

'Created after' search timestamp

whetherContactSConversationIsResolved: Nullable<Boolean>

Whether contact's conversation is resolved

whetherContactIsBlocked: Nullable<Boolean>

Whether contact is blocked

whetherContactIsArchived: Nullable<Boolean>

Whether contact is archived

whetherContactIsSuppressed: Nullable<Boolean>

Whether contact is suppressed

whetherContactHasOptedOut: Nullable<Boolean>

Whether contact has opted out

lastMessageTimeSentBeforeSearchTimestamp: String

'Last-message-time sent before' search timestamp

lastMessageTimeSentAfterSearchTimestamp: String

'Last-message-time sent after' search timestamp

lastMessageTimeReceivedBeforeSearchTimestamp: String

'Last-message-time received before' search timestamp

lastMessageTimeReceivedAfterSearchTimestamp: String

'Last-message-time received after' search timestamp

contactTags: String

Contact Tags

contactGroups: String

Contact Groups

idOfCustomFieldToFilterBy: String

Id of custom field to filter by

valueOfCustomFieldToFilterBy: String

Value of custom field to filter by

idOfSecondCustomFieldToFilterBy: String

Id of second custom field to filter by

valueOfSecondCustomFieldToFilterBy: String

Value of second custom field to filter by

idOfThirdCustomFieldToFilterBy: String

Id of third custom field to filter by

valueOfThirdCustomFieldToFilterBy: String

Value of third custom field to filter by

cancellationToken: CancellationToken

Cancellation token.

Returns

Task<GetContactsResponse>

The Get all contacts that match the specified filtering criterion response.

Remarks

Gets all contacts that match the specified filtering criterion. Only the dashboard specified will be searched; there is no account level search for a number available.

Applies to

Feedback

Was this page helpful?