StartChatContactRequest Class | AWS SDK for .NET V3

Container for the parameters to the StartChatContact operation. Initiates a flow to start a new chat for the customer. Response of this API provides a token required to obtain credentials from the CreateParticipantConnection API in the Amazon Connect Participant Service.

When a new chat contact is successfully created, clients must subscribe to the participant’s connection for the created chat within 5 minutes. This is achieved by invoking CreateParticipantConnection with WEBSOCKET and CONNECTION_CREDENTIALS.

A 429 error occurs in the following situations:

API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception.
The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

If you use the ChatDurationInMinutes parameter and receive a 400 error, your account may not support the ability to configure custom chat durations. For more information, contact Amazon Web Services Support.

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

Inheritance Hierarchy

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

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

Syntax

public class StartChatContactRequest : AmazonConnectRequest
         IAmazonWebServiceRequest

The StartChatContactRequest type exposes the following members

Constructors

	Name	Description
	StartChatContactRequest()

Properties

Name	Type	Description
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. They can be accessed in flows just like any other contact attributes. There can be up to 32,768 UTF-8 bytes across all key-value pairs per contact. Attribute keys can include only alphanumeric, dash, and underscore characters.
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).
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 Amazon Web Services SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs.
ContactFlowId	System.String	Gets and sets the property ContactFlowId. The identifier of the flow for initiating the chat. To see the ContactFlowId in the Amazon Connect admin website, on the navigation menu go to Routing, 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/846ec553-a005-41c0-8341-xxxxxxxxxxxx
InitialMessage	Amazon.Connect.Model.ChatMessage	Gets and sets the property InitialMessage. The initial message to be sent to the newly created chat. If you have a Lex bot in your flow, the initial message is not delivered to the Lex bot.
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.
ParticipantDetails	Amazon.Connect.Model.ParticipantDetails	Gets and sets the property ParticipantDetails. Information identifying the participant.
PersistentChat	Amazon.Connect.Model.PersistentChat	Gets and sets the property PersistentChat. Enable persistent chats. For more information about enabling persistent chat, and for example use cases and how to configure for them, see Enable persistent chat.
RelatedContactId	System.String	Gets and sets the property RelatedContactId. The unique identifier for an Amazon Connect contact. This identifier is related to the chat starting. You cannot provide data for both RelatedContactId and PersistentChat.
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`. The types `application/vnd.amazonaws.connect.message.interactive` and `application/vnd.amazonaws.connect.message.interactive.response` must be present in the SupportedMessagingContentTypes field of this API in order to set `SegmentAttributes` as {`"connect:Subtype": {"valueString" : "connect:Guide" }}`.
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`, and `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]`. The type `application/vnd.amazonaws.connect.message.interactive` is required to use the Show view flow block.

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