ConnectParticipant

Client

class ConnectParticipant.Client

A low-level client representing Amazon Connect Participant Service

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center. Amazon Connect enables customer contacts through voice or chat. Use the Amazon Connect Participant Service to manage chat participants, such as agents and customers.

import boto3

client = boto3.client('connectparticipant')

These are the available methods:

can_paginate(operation_name)

Check if an operation can be paginated.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Returns
True if the operation can be paginated, False otherwise.
close()

Closes underlying endpoint connections.

complete_attachment_upload(**kwargs)

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

Note

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

response = client.complete_attachment_upload(
    AttachmentIds=[
        'string',
    ],
    ClientToken='string',
    ConnectionToken='string'
)
Parameters
  • AttachmentIds (list) --

    [REQUIRED]

    A list of unique identifiers for the attachments.

    • (string) --
  • ClientToken (string) --

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the participant's connection.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • ConnectParticipant.Client.exceptions.AccessDeniedException
  • ConnectParticipant.Client.exceptions.InternalServerException
  • ConnectParticipant.Client.exceptions.ThrottlingException
  • ConnectParticipant.Client.exceptions.ValidationException
  • ConnectParticipant.Client.exceptions.ServiceQuotaExceededException
  • ConnectParticipant.Client.exceptions.ConflictException
create_participant_connection(**kwargs)

Creates the participant's connection.

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. This can be omitted if ConnectParticipant is true .

    • (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 message streaming.
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

  • ConnectParticipant.Client.exceptions.AccessDeniedException
  • ConnectParticipant.Client.exceptions.InternalServerException
  • ConnectParticipant.Client.exceptions.ThrottlingException
  • ConnectParticipant.Client.exceptions.ValidationException
disconnect_participant(**kwargs)

Disconnects a participant.

Note

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

response = client.disconnect_participant(
    ClientToken='string',
    ConnectionToken='string'
)
Parameters
  • ClientToken (string) --

    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.

    This field is autopopulated if not provided.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the participant's connection.

Return type

dict

Returns

Response Syntax

{}

Response Structure

  • (dict) --

Exceptions

  • ConnectParticipant.Client.exceptions.AccessDeniedException
  • ConnectParticipant.Client.exceptions.InternalServerException
  • ConnectParticipant.Client.exceptions.ThrottlingException
  • ConnectParticipant.Client.exceptions.ValidationException
get_attachment(**kwargs)

Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.

Note

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

response = client.get_attachment(
    AttachmentId='string',
    ConnectionToken='string'
)
Parameters
  • AttachmentId (string) --

    [REQUIRED]

    A unique identifier for the attachment.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the participant's connection.

Return type

dict

Returns

Response Syntax

{
    'Url': 'string',
    'UrlExpiry': 'string'
}

Response Structure

  • (dict) --

    • Url (string) --

      This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

    • UrlExpiry (string) --

      The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

Exceptions

  • ConnectParticipant.Client.exceptions.AccessDeniedException
  • ConnectParticipant.Client.exceptions.InternalServerException
  • ConnectParticipant.Client.exceptions.ThrottlingException
  • ConnectParticipant.Client.exceptions.ValidationException
get_paginator(operation_name)

Create a paginator for an operation.

Parameters
operation_name (string) -- The operation name. This is the same name as the method name on the client. For example, if the method name is create_foo, and you'd normally invoke the operation as client.create_foo(**kwargs), if the create_foo operation can be paginated, you can use the call client.get_paginator("create_foo").
Raises OperationNotPageableError
Raised if the operation is not pageable. You can use the client.can_paginate method to check if an operation is pageable.
Return type
L{botocore.paginate.Paginator}
Returns
A paginator object.
get_transcript(**kwargs)

Retrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent chat, see Enable persistent chat.

Note

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

response = client.get_transcript(
    ContactId='string',
    MaxResults=123,
    NextToken='string',
    ScanDirection='FORWARD'|'BACKWARD',
    SortOrder='DESCENDING'|'ASCENDING',
    StartPosition={
        'Id': 'string',
        'AbsoluteTime': 'string',
        'MostRecent': 123
    },
    ConnectionToken='string'
)
Parameters
  • ContactId (string) -- The contactId from the current contact chain for which transcript is needed.
  • MaxResults (integer) -- The maximum number of results to return in the page. Default: 10.
  • NextToken (string) -- The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
  • ScanDirection (string) -- The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
  • SortOrder (string) -- The sort order for the records. Default: DESCENDING.
  • StartPosition (dict) --

    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.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the participant's connection.

Return type

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'|'MESSAGE_DELIVERED'|'MESSAGE_READ',
            'ParticipantId': 'string',
            'DisplayName': 'string',
            'ParticipantRole': 'AGENT'|'CUSTOMER'|'SYSTEM',
            'Attachments': [
                {
                    'ContentType': 'string',
                    'AttachmentId': 'string',
                    'AttachmentName': 'string',
                    'Status': 'APPROVED'|'REJECTED'|'IN_PROGRESS'
                },
            ],
            'MessageMetadata': {
                'MessageId': 'string',
                'Receipts': [
                    {
                        'DeliveredTimestamp': 'string',
                        'ReadTimestamp': 'string',
                        'RecipientParticipantId': 'string'
                    },
                ]
            },
            'RelatedContactId': 'string',
            'ContactId': 'string'
        },
    ],
    '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.

        • MessageMetadata (dict) --

          The metadata related to the message. Currently this supports only information related to message receipts.

          • MessageId (string) --

            The identifier of the message that contains the metadata information.

          • Receipts (list) --

            The list of receipt information for a message for different recipients.

            • (dict) --

              The receipt for the message delivered to the recipient.

              • DeliveredTimestamp (string) --

                The time when the message was delivered to the recipient.

              • ReadTimestamp (string) --

                The time when the message was read by the recipient.

              • RecipientParticipantId (string) --

                The identifier of the recipient of the message.

        • RelatedContactId (string) --

          The contactId on which the transcript item was originally sent. This field is only populated for persistent chats when the transcript item is from the past chat session. For more information, see Enable persistent chat.

        • ContactId (string) --

          The contactId on which the transcript item was originally sent. This field is populated only when the transcript item is from the current chat session.

    • NextToken (string) --

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

Exceptions

  • ConnectParticipant.Client.exceptions.AccessDeniedException
  • ConnectParticipant.Client.exceptions.InternalServerException
  • ConnectParticipant.Client.exceptions.ThrottlingException
  • ConnectParticipant.Client.exceptions.ValidationException
get_waiter(waiter_name)

Returns an object that can wait for some condition.

Parameters
waiter_name (str) -- The name of the waiter to get. See the waiters section of the service docs for a list of available waiters.
Returns
The specified waiter object.
Return type
botocore.waiter.Waiter
send_event(**kwargs)

Sends an event.

Note

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

response = client.send_event(
    ContentType='string',
    Content='string',
    ClientToken='string',
    ConnectionToken='string'
)
Parameters
  • ContentType (string) --

    [REQUIRED]

    The content type of the request. Supported types are:

    • application/vnd.amazonaws.connect.event.typing
    • application/vnd.amazonaws.connect.event.connection.acknowledged
    • application/vnd.amazonaws.connect.event.message.delivered
    • application/vnd.amazonaws.connect.event.message.read
  • Content (string) --

    The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.

    Sample Content: "{"messageId":"11111111-aaaa-bbbb-cccc-EXAMPLE01234"}"

  • ClientToken (string) --

    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.

    This field is autopopulated if not provided.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the participant's connection.

Return type

dict

Returns

Response Syntax

{
    'Id': 'string',
    'AbsoluteTime': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The ID of the response.

    • AbsoluteTime (string) --

      The time when the event was sent.

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

Exceptions

  • ConnectParticipant.Client.exceptions.AccessDeniedException
  • ConnectParticipant.Client.exceptions.InternalServerException
  • ConnectParticipant.Client.exceptions.ThrottlingException
  • ConnectParticipant.Client.exceptions.ValidationException
send_message(**kwargs)

Sends a message.

Note

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

response = client.send_message(
    ContentType='string',
    Content='string',
    ClientToken='string',
    ConnectionToken='string'
)
Parameters
  • ContentType (string) --

    [REQUIRED]

    The type of the content. Supported types are text/plain , text/markdown , and application/json .

  • Content (string) --

    [REQUIRED]

    The content of the message.

    • For text/plain and text/markdown , the Length Constraints are Minimum of 1, Maximum of 1024.
    • For application/json , the Length Constraints are Minimum of 1, Maximum of 12000.
  • ClientToken (string) --

    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.

    This field is autopopulated if not provided.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the connection.

Return type

dict

Returns

Response Syntax

{
    'Id': 'string',
    'AbsoluteTime': 'string'
}

Response Structure

  • (dict) --

    • Id (string) --

      The ID of the message.

    • AbsoluteTime (string) --

      The time when the message was sent.

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

Exceptions

  • ConnectParticipant.Client.exceptions.AccessDeniedException
  • ConnectParticipant.Client.exceptions.InternalServerException
  • ConnectParticipant.Client.exceptions.ThrottlingException
  • ConnectParticipant.Client.exceptions.ValidationException
start_attachment_upload(**kwargs)

Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.

Note

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

response = client.start_attachment_upload(
    ContentType='string',
    AttachmentSizeInBytes=123,
    AttachmentName='string',
    ClientToken='string',
    ConnectionToken='string'
)
Parameters
  • ContentType (string) --

    [REQUIRED]

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

  • AttachmentSizeInBytes (integer) --

    [REQUIRED]

    The size of the attachment in bytes.

  • AttachmentName (string) --

    [REQUIRED]

    A case-sensitive name of the attachment being uploaded.

  • ClientToken (string) --

    [REQUIRED]

    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.

    This field is autopopulated if not provided.

  • ConnectionToken (string) --

    [REQUIRED]

    The authentication token associated with the participant's connection.

Return type

dict

Returns

Response Syntax

{
    'AttachmentId': 'string',
    'UploadMetadata': {
        'Url': 'string',
        'UrlExpiry': 'string',
        'HeadersToInclude': {
            'string': 'string'
        }
    }
}

Response Structure

  • (dict) --

    • AttachmentId (string) --

      A unique identifier for the attachment.

    • UploadMetadata (dict) --

      Fields to be used while uploading the attachment.

      • Url (string) --

        This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.

      • UrlExpiry (string) --

        The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.

      • HeadersToInclude (dict) --

        The headers to be provided while uploading the file to the URL.

        • (string) --
          • (string) --

Exceptions

  • ConnectParticipant.Client.exceptions.AccessDeniedException
  • ConnectParticipant.Client.exceptions.InternalServerException
  • ConnectParticipant.Client.exceptions.ThrottlingException
  • ConnectParticipant.Client.exceptions.ValidationException
  • ConnectParticipant.Client.exceptions.ServiceQuotaExceededException

Paginators

The available paginators are: