ConnectParticipant / Client / create_participant_connection

create_participant_connection#

ConnectParticipant.Client.create_participant_connection(**kwargs)#

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.

See also: AWS API Documentation

Request Syntax

response = client.create_participant_connection(
    Type=[
        'WEBSOCKET'|'CONNECTION_CREDENTIALS',
    ],
    ParticipantToken='string',
    ConnectParticipant=True|False
)
Parameters:

  • Type (list) –

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

    • (string) –

  • ParticipantToken (string) –

    [REQUIRED]

    This is a header parameter.

    The ParticipantToken as obtained from StartChatContact API response.

  • ConnectParticipant (boolean) – 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.

Return type:

dict

Returns:

Response Syntax

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

Response Structure

  • (dict) –

    • Websocket (dict) –

      Creates the participant’s websocket connection.

      • Url (string) –

        The URL of the websocket.

      • ConnectionExpiry (string) –

        The URL expiration timestamp in ISO date format.

        It’s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

    • ConnectionCredentials (dict) –

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

      • ConnectionToken (string) –

        The connection token.

      • Expiry (string) –

        The expiration of the token.

        It’s specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Exceptions