TextRequestClient.GetConversationsAsync Method

Definition

Namespace:

Azure.Connectors.Sdk.TextRequest

Assembly:

Azure.Connectors.Sdk.dll

Package:

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

Gets all conversations for this dashboard

public virtual System.Threading.Tasks.Task<Azure.Connectors.Sdk.TextRequest.Models.GetConversationsResponse> GetConversationsAsync(int idOfTheDashboardToMakeThisCallOn, string contactTags = default, string whetherToShowOnlyResolvedConversations = default, string whetherToIncludeArchivedConversations = default, string termToFilterByForPhoneNumbersAndContactName = default, int? numberPageToGet = default, int? amountOfEachEntityToGetPerPage = default, System.Threading.CancellationToken cancellationToken = default);

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

Public Overridable Function GetConversationsAsync (idOfTheDashboardToMakeThisCallOn As Integer, Optional contactTags As String = Nothing, Optional whetherToShowOnlyResolvedConversations As String = Nothing, Optional whetherToIncludeArchivedConversations As String = Nothing, Optional termToFilterByForPhoneNumbersAndContactName As String = Nothing, Optional numberPageToGet As Nullable(Of Integer) = Nothing, Optional amountOfEachEntityToGetPerPage As Nullable(Of Integer) = Nothing, Optional cancellationToken As CancellationToken = Nothing) As Task(Of GetConversationsResponse)

Parameters

idOfTheDashboardToMakeThisCallOn

Int32

Id of the dashboard to make this call on

contactTags

String

Contact Tags

whetherToShowOnlyResolvedConversations

String

Whether to show only resolved conversations

whetherToIncludeArchivedConversations

String

Whether to include archived conversations

termToFilterByForPhoneNumbersAndContactName

String

Term to filter by for phone numbers and contact name

numberPageToGet

Nullable<Int32>

Number page to get

amountOfEachEntityToGetPerPage

Nullable<Int32>

Amount of each entity to get per page

cancellationToken

CancellationToken

Cancellation token.

Returns

Task<GetConversationsResponse>

The Gets all conversations for this dashboard response.

Remarks

Gets all conversations for this dashboard, and includes info on the last message for each conversation.