com.amazonaws.services.connect.model

Class StartChatContactRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.connect.model.StartChatContactRequest

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class StartChatContactRequest
extends AmazonWebServiceRequest
implements java.io.Serializable

Initiates a contact 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 need to 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 two situations:

• API rate limit is exceeded. API TPS throttling returns a TooManyRequests exception from the API Gateway.

• The quota for concurrent active chats is exceeded. Active chat throttling returns a LimitExceededException.

For more information about how chat works, see Chat in the Amazon Connect Administrator Guide.

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
StartChatContactRequest()

Method Summary

Modifier and Type	Method and Description
StartChatContactRequest	addAttributesEntry(java.lang.String key, java.lang.String value) A custom key-value pair using an attribute map.
StartChatContactRequest	clearAttributesEntries() Removes all the entries added into Attributes.
boolean	equals(java.lang.Object obj)
java.util.Map<java.lang.String,java.lang.String>	getAttributes() A custom key-value pair using an attribute map.
java.lang.String	getClientToken() A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
java.lang.String	getContactFlowId() The identifier of the contact flow for initiating the chat.
ChatMessage	getInitialMessage() The initial message to be sent to the newly created chat.
java.lang.String	getInstanceId() The identifier of the Amazon Connect instance.
ParticipantDetails	getParticipantDetails() Information identifying the participant.
int	hashCode()
void	setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) A custom key-value pair using an attribute map.
void	setClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
void	setContactFlowId(java.lang.String contactFlowId) The identifier of the contact flow for initiating the chat.
void	setInitialMessage(ChatMessage initialMessage) The initial message to be sent to the newly created chat.
void	setInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
void	setParticipantDetails(ParticipantDetails participantDetails) Information identifying the participant.
java.lang.String	toString() Returns a string representation of this object; useful for testing and debugging.
StartChatContactRequest	withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes) A custom key-value pair using an attribute map.
StartChatContactRequest	withClientToken(java.lang.String clientToken) A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
StartChatContactRequest	withContactFlowId(java.lang.String contactFlowId) The identifier of the contact flow for initiating the chat.
StartChatContactRequest	withInitialMessage(ChatMessage initialMessage) The initial message to be sent to the newly created chat.
StartChatContactRequest	withInstanceId(java.lang.String instanceId) The identifier of the Amazon Connect instance.
StartChatContactRequest	withParticipantDetails(ParticipantDetails participantDetails) Information identifying the participant.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

clone, getCloneRoot, getCloneSource, getGeneralProgressListener, getRequestClientOptions, getRequestCredentials, getRequestMetricCollector, setGeneralProgressListener, setRequestCredentials, setRequestMetricCollector, withGeneralProgressListener, withRequestMetricCollector

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

StartChatContactRequest

public StartChatContactRequest()

Method Detail

getInstanceId

public java.lang.String getInstanceId()

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Returns:

The identifier of the Amazon Connect instance.

setInstanceId

public void setInstanceId(java.lang.String instanceId)

The identifier of the Amazon Connect instance.

Constraints:
Length: 1 - 100

Parameters:

instanceId -

The identifier of the Amazon Connect instance.

withInstanceId

public StartChatContactRequest withInstanceId(java.lang.String instanceId)

The identifier of the Amazon Connect instance.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: 1 - 100

Parameters:

instanceId -

The identifier of the Amazon Connect instance.

Returns:

A reference to this updated object so that method calls can be chained together.

getContactFlowId

public java.lang.String getContactFlowId()

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

Constraints:
Length: - 500

Returns:

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

setContactFlowId

public void setContactFlowId(java.lang.String contactFlowId)

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

Constraints:
Length: - 500

Parameters:

contactFlowId -

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

withContactFlowId

public StartChatContactRequest withContactFlowId(java.lang.String contactFlowId)

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: - 500

Parameters:

contactFlowId -

The identifier of the contact flow for initiating the chat. To see the ContactFlowId in the Amazon Connect console user interface, on the navigation menu go to Routing, Contact Flows. Choose the contact flow. On the contact flow page, under the name of the contact 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

Returns:

A reference to this updated object so that method calls can be chained together.

getAttributes

public java.util.Map<java.lang.String,java.lang.String> getAttributes()

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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.

Returns:

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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.

setAttributes

public void setAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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.

Parameters:

attributes -

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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.

withAttributes

public StartChatContactRequest withAttributes(java.util.Map<java.lang.String,java.lang.String> attributes)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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.

Returns a reference to this object so that method calls can be chained together.

Parameters:

attributes -

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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.

Returns:

A reference to this updated object so that method calls can be chained together.

addAttributesEntry

public StartChatContactRequest addAttributesEntry(java.lang.String key,
                                                  java.lang.String value)

A custom key-value pair using an attribute map. The attributes are standard Amazon Connect attributes, and can be accessed in contact 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.

The method adds a new key-value pair into Attributes parameter, and returns a reference to this object so that method calls can be chained together.

Parameters:

key - The key of the entry to be added into Attributes.

value - The corresponding value of the entry to be added into Attributes.

Returns:

A reference to this updated object so that method calls can be chained together.

clearAttributesEntries

public StartChatContactRequest clearAttributesEntries()

Removes all the entries added into Attributes.

Returns a reference to this object so that method calls can be chained together.

getParticipantDetails

public ParticipantDetails getParticipantDetails()

Information identifying the participant.

Returns:

Information identifying the participant.

setParticipantDetails

public void setParticipantDetails(ParticipantDetails participantDetails)

Information identifying the participant.

Parameters:

participantDetails -

Information identifying the participant.

withParticipantDetails

public StartChatContactRequest withParticipantDetails(ParticipantDetails participantDetails)

Information identifying the participant.

Returns a reference to this object so that method calls can be chained together.

Parameters:

participantDetails -

Information identifying the participant.

Returns:

A reference to this updated object so that method calls can be chained together.

getInitialMessage

public ChatMessage getInitialMessage()

The initial message to be sent to the newly created chat.

Returns:

The initial message to be sent to the newly created chat.

setInitialMessage

public void setInitialMessage(ChatMessage initialMessage)

The initial message to be sent to the newly created chat.

Parameters:

initialMessage -

The initial message to be sent to the newly created chat.

withInitialMessage

public StartChatContactRequest withInitialMessage(ChatMessage initialMessage)

The initial message to be sent to the newly created chat.

Returns a reference to this object so that method calls can be chained together.

Parameters:

initialMessage -

The initial message to be sent to the newly created chat.

Returns:

A reference to this updated object so that method calls can be chained together.

getClientToken

public java.lang.String getClientToken()

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

Returns:

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

setClientToken

public void setClientToken(java.lang.String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Constraints:
Length: - 500

Parameters:

clientToken -

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

withClientToken

public StartChatContactRequest withClientToken(java.lang.String clientToken)

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns a reference to this object so that method calls can be chained together.

Constraints:
Length: - 500

Parameters:

clientToken -

A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.

Returns:

A reference to this updated object so that method calls can be chained together.

toString

public java.lang.String toString()

Returns a string representation of this object; useful for testing and debugging.

Overrides:

toString in class java.lang.Object

Returns:

A string representation of this object.

See Also:

Object.toString()

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object