Amazon Connect Participant Service

{'ConnectParticipant': 'boolean'}

Creates the participant's connection. Note that 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 .

See also: AWS API Documentation

Request Syntax

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

type Type

list

param Type

[REQUIRED]

Type of connection information required.

• (string) --

type ParticipantToken

string

param ParticipantToken

[REQUIRED]

This is a header parameter.

The ParticipantToken as obtained from StartChatContact API response.

type ConnectParticipant

boolean

param ConnectParticipant

Amazon Connect Participant is used to mark the participant as connected for message streaming.

rtype

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.

{'Transcript': {'Type': {'PARTICIPANT_ACTIVE',
                         'PARTICIPANT_DISENGAGED',
                         'PARTICIPANT_ENGAGED',
                         'PARTICIPANT_INACTIVE'}}}

Retrieves a transcript of the session, including details about any attachments. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

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

See also: AWS API Documentation

Request Syntax

client.get_transcript(
    ContactId='string',
    MaxResults=123,
    NextToken='string',
    ScanDirection='FORWARD'|'BACKWARD',
    SortOrder='DESCENDING'|'ASCENDING',
    StartPosition={
        'Id': 'string',
        'AbsoluteTime': 'string',
        'MostRecent': 123
    },
    ConnectionToken='string'
)

type ContactId

string

param ContactId

The contactId from the current contact chain for which transcript is needed.

type MaxResults

integer

param MaxResults

The maximum number of results to return in the page. Default: 10.

type NextToken

string

param NextToken

The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.

type ScanDirection

string

param ScanDirection

The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.

type SortOrder

string

param SortOrder

The sort order for the records. Default: DESCENDING.

type StartPosition

dict

param StartPosition

A filtering option for where to start.

• Id (string) --

  The ID of the message or event where to start.

• AbsoluteTime (string) --

  The time in ISO format where to start.

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

• MostRecent (integer) --

  The start position of the most recent message where you want to start.

type ConnectionToken

string

param ConnectionToken

[REQUIRED]

The authentication token associated with the participant's connection.

rtype

dict

returns

Response Syntax

{
    'InitialContactId': 'string',
    'Transcript': [
        {
            'AbsoluteTime': 'string',
            'Content': 'string',
            'ContentType': 'string',
            'Id': 'string',
            'Type': 'TYPING'|'PARTICIPANT_JOINED'|'PARTICIPANT_LEFT'|'CHAT_ENDED'|'TRANSFER_SUCCEEDED'|'TRANSFER_FAILED'|'MESSAGE'|'EVENT'|'ATTACHMENT'|'CONNECTION_ACK'|'PARTICIPANT_ACTIVE'|'PARTICIPANT_INACTIVE'|'PARTICIPANT_ENGAGED'|'PARTICIPANT_DISENGAGED',
            'ParticipantId': 'string',
            'DisplayName': 'string',
            'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM',
            'Attachments': [
                {
                    'ContentType': 'string',
                    'AttachmentId': 'string',
                    'AttachmentName': 'string',
                    'Status': 'APPROVED'|'REJECTED'|'IN_PROGRESS'
                },
            ]
        },
    ],
    'NextToken': 'string'
}

Response Structure

• (dict) --

  • InitialContactId (string) --

    The initial contact ID for the contact.

  • Transcript (list) --

    The list of messages in the session.

    • (dict) --

      An item - message or event - that has been sent.

      • AbsoluteTime (string) --

        The time when the message or event was sent.

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

      • Content (string) --

        The content of the message or event.

      • ContentType (string) --

        The type of content of the item.

      • Id (string) --

        The ID of the item.

      • Type (string) --

        Type of the item: message or event.

      • ParticipantId (string) --

        The ID of the sender in the session.

      • DisplayName (string) --

        The chat display name of the sender.

      • ParticipantRole (string) --

        The role of the sender. For example, is it a customer, agent, or system.

      • Attachments (list) --

        Provides information about the attachments.

        • (dict) --

          The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded.

          • ContentType (string) --

            Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide .

          • AttachmentId (string) --

            A unique identifier for the attachment.

          • AttachmentName (string) --

            A case-sensitive name of the attachment being uploaded.

          • Status (string) --

            Status of the attachment.

  • NextToken (string) --

    The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.