AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the StartOutboundChatContact operation. Initiates a new outbound SMS contact to a customer. Response of this API provides the ContactId of the outbound SMS contact created.

SourceEndpoint only supports Endpoints with CONNECT_PHONENUMBER_ARN as Type and DestinationEndpoint only supports Endpoints with TELEPHONE_NUMBER as Type. ContactFlowId initiates the flow to manage the new SMS contact created.

This API can be used to initiate outbound SMS contacts for an agent, or it can also deflect an ongoing contact to an outbound SMS contact by using the StartOutboundChatContact Flow Action.

For more information about using SMS in Amazon Connect, see the following topics in the Amazon Connect Administrator Guide:

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.Connect.AmazonConnectRequest
      Amazon.Connect.Model.StartOutboundChatContactRequest

Namespace: Amazon.Connect.Model
Assembly: AWSSDK.Connect.dll
Version: 3.x.y.z

Syntax

C# 
public class StartOutboundChatContactRequest : AmazonConnectRequest
         IAmazonWebServiceRequest

The StartOutboundChatContactRequest type exposes the following members

Constructors

NameDescription
Public Method StartOutboundChatContactRequest()

Properties

NameTypeDescription
Public Property Attributes System.Collections.Generic.Dictionary<System.String, System.String>

Gets and sets the property Attributes.

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in flows just like any other contact attributes.

Public Property ChatDurationInMinutes System.Int32

Gets and sets the property ChatDurationInMinutes.

The total duration of the newly started chat session. If not specified, the chat session duration defaults to 25 hour. The minimum configurable time is 60 minutes. The maximum configurable time is 10,080 minutes (7 days).

Public Property ClientToken System.String

Gets and sets the property ClientToken.

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs. The token is valid for 7 days after creation. If a contact is already started, the contact ID is returned.

Public Property ContactFlowId System.String

Gets and sets the property ContactFlowId.

The identifier of the flow for the call. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the flow. On the flow page, under the name of the flow, choose Show additional flow information. The ContactFlowId is the last part of the ARN, shown here in bold:

  • arn:aws:connect:us-west-2:xxxxxxxxxxxx:instance/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/contact-flow/123ec456-a007-89c0-1234-xxxxxxxxxxxx

Public Property DestinationEndpoint Amazon.Connect.Model.Endpoint

Gets and sets the property DestinationEndpoint.

Public Property InitialSystemMessage Amazon.Connect.Model.ChatMessage

Gets and sets the property InitialSystemMessage.

Public Property InstanceId System.String

Gets and sets the property InstanceId.

The identifier of the Amazon Connect instance. You can find the instance ID in the Amazon Resource Name (ARN) of the instance.

Public Property ParticipantDetails Amazon.Connect.Model.ParticipantDetails

Gets and sets the property ParticipantDetails.

Public Property RelatedContactId System.String

Gets and sets the property RelatedContactId.

The unique identifier for an Amazon Connect contact. This identifier is related to the contact starting.

Public Property SegmentAttributes System.Collections.Generic.Dictionary<System.String, Amazon.Connect.Model.SegmentAttributeValue>

Gets and sets the property SegmentAttributes.

A set of system defined key-value pairs stored on individual contact segments using an attribute map. The attributes are standard Amazon Connect attributes. They can be accessed in flows.

  • Attribute keys can include only alphanumeric, -, and _.

  • This field can be used to show channel subtype, such as connect:Guide and connect:SMS.

Public Property SourceEndpoint Amazon.Connect.Model.Endpoint

Gets and sets the property SourceEndpoint.

Public Property SupportedMessagingContentTypes System.Collections.Generic.List<System.String>

Gets and sets the property SupportedMessagingContentTypes.

The supported chat message content types. Supported types are:

  • text/plain

  • text/markdown

  • application/json, application/vnd.amazonaws.connect.message.interactive

  • application/vnd.amazonaws.connect.message.interactive.response

Content types must always contain text/plain. You can then put any other supported type in the list. For example, all the following lists are valid because they contain text/plain:

  • [text/plain, text/markdown, application/json]

  • [text/markdown, text/plain]

  • [text/plain, application/json, application/vnd.amazonaws.connect.message.interactive.response]

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5