TextRequestClient.ArchiveConversationAsync Method

Definition

Archive a Conversation

public virtual System.Threading.Tasks.Task<string> ArchiveConversationAsync(int idOfTheDashboardToMakeThisCallOn, string phoneNumberOfConversation, System.Threading.CancellationToken cancellationToken = default);
abstract member ArchiveConversationAsync : int * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
override this.ArchiveConversationAsync : int * string * System.Threading.CancellationToken -> System.Threading.Tasks.Task<string>
Public Overridable Function ArchiveConversationAsync (idOfTheDashboardToMakeThisCallOn As Integer, phoneNumberOfConversation As String, Optional cancellationToken As CancellationToken = Nothing) As Task(Of String)

Parameters

idOfTheDashboardToMakeThisCallOn
Int32

Id of the dashboard to make this call on

phoneNumberOfConversation
String

Phone Number of conversation

cancellationToken
CancellationToken

Cancellation token.

Returns

The Archive a Conversation response.

Remarks

Archives a conversation, removing it from the results of all conversation retrieval endpoints. A conversation will be automatically unarchived if the customer sends a text to your Text Request number, or if you send the customer a text from your Text Request number. Archiving conversations is a good way to remove clutter from customers you don't plan on talking to in the future. Note that if a customer texts in "STOP" to prevent you from sending them any further SMS messages, the conversation is automatically archived.

Applies to