Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

CreateParticipantConnection

Creates the participant's connection.

For security recommendations, see Amazon Connect Chat security best practices.

Note

ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until they are part of a contact.

The response URL for WEBSOCKET Type has a connect expiry timeout of 100s. Clients must manually connect to the returned websocket URL and subscribe to the desired topic.

For chat, you need to publish the following on the established websocket connection:

{"topic":"aws/subscribe","content":{"topics":["aws/chat"]}}

Upon websocket URL expiry, as specified in the response ConnectionExpiry parameter, clients need to call this API again to obtain a new websocket URL and perform the same steps as before.

Message streaming support: This API can also be used together with the StartContactStreaming API to create a participant connection for chat contacts that are not using a websocket. For more information about message streaming, Enable real-time chat message streaming in the Amazon Connect Administrator Guide.

Feature specifications: For information about feature specifications, such as the allowed number of open websocket connections per participant, see Feature specifications in the Amazon Connect Administrator Guide.

Note

The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.

Request Syntax


POST /participant/connection HTTP/1.1
X-Amz-Bearer: ParticipantToken
Content-type: application/json

{
   "ConnectParticipant": boolean,
   "Type": [ "string" ]
}

URI Request Parameters

The request uses the following URI parameters.

ParticipantToken

This is a header parameter.

The ParticipantToken as obtained from StartChatContact API response.

Length Constraints: Minimum length of 1. Maximum length of 1000.

Required: Yes

Request Body

The request accepts the following data in JSON format.

ConnectParticipant

Amazon Connect Participant is used to mark the participant as connected for customer participant in message streaming, as well as for agent or manager participant in non-streaming chats.

Type: Boolean

Required: No

Type

Type of connection information required. If you need CONNECTION_CREDENTIALS along with marking participant as connected, pass CONNECTION_CREDENTIALS in Type.

Type: Array of strings

Array Members: Minimum number of 1 item.

Valid Values: WEBSOCKET | CONNECTION_CREDENTIALS

Required: No

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "ConnectionCredentials": { 
      "ConnectionToken": "string",
      "Expiry": "string"
   },
   "Websocket": { 
      "ConnectionExpiry": "string",
      "Url": "string"
   }
}

Response Elements

If the action is successful, the service sends back an HTTP 200 response.

The following data is returned in JSON format by the service.

ConnectionCredentials

Creates the participant's connection credentials. The authentication token associated with the participant's connection.

Type: ConnectionCredentials object

Websocket

Creates the participant's websocket connection.

Type: Websocket object

Errors

For information about the errors that are common to all actions, see Common Errors.

AccessDeniedException

You do not have sufficient access to perform this action.

HTTP Status Code: 403

InternalServerException

This exception occurs when there is an internal failure in the Amazon Connect service.

HTTP Status Code: 500

ThrottlingException

The request was denied due to request throttling.

HTTP Status Code: 429

ValidationException

The input fails to satisfy the constraints specified by Amazon Connect.

HTTP Status Code: 400