CancelParticipantAuthentication

$result = $client->cancelParticipantAuthentication([/* ... */]);
$promise = $client->cancelParticipantAuthenticationAsync([/* ... */]);

Cancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken.

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

Parameter Syntax

$result = $client->cancelParticipantAuthentication([
    'ConnectionToken' => '<string>', // REQUIRED
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

CompleteAttachmentUpload

$result = $client->completeAttachmentUpload([/* ... */]);
$promise = $client->completeAttachmentUploadAsync([/* ... */]);

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown when an attachment with that identifier is already being uploaded.

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

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

Parameter Syntax

$result = $client->completeAttachmentUpload([
    'AttachmentIds' => ['<string>', ...], // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'ConnectionToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ServiceQuotaExceededException:

The number of attachments per contact exceeds the quota.

ConflictException:

The requested operation conflicts with the current state of a service resource associated with the request.

CreateParticipantConnection

$result = $client->createParticipantConnection([/* ... */]);
$promise = $client->createParticipantConnectionAsync([/* ... */]);

Creates the participant's connection.

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

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

The participant token is valid for the lifetime of the participant – until they are part of a contact. For WebRTC participants, if they leave or are disconnected for 60 seconds, a new participant needs to be created using the CreateParticipant API.

For WEBSOCKET Type:

The response URL for 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.

The expiry time for the connection token is different than the ChatDurationInMinutes. Expiry time for the connection token is 1 day.

For WEBRTC_CONNECTION Type:

The response includes connection data required for the client application to join the call using the Amazon Chime SDK client libraries. The WebRTCConnection response contains Meeting and Attendee information needed to establish the media connection.

The attendee join token in WebRTCConnection response is valid for the lifetime of the participant in the call. If a participant leaves or is disconnected for 60 seconds, their participant credentials will no longer be valid, and a new participant will need to be created to rejoin the call.

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.

Multi-user web, in-app, video calling support:

For WebRTC calls, this API is used in conjunction with the CreateParticipant API to enable multi-party calling. The StartWebRTCContact API creates the initial contact and routes it to an agent, while CreateParticipant adds additional participants to the ongoing call. For more information about multi-party WebRTC calls, see Enable multi-user web, in-app, and video calling in the Amazon Connect Administrator Guide.

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

Parameter Syntax

$result = $client->createParticipantConnection([
    'ConnectParticipant' => true || false,
    'ParticipantToken' => '<string>', // REQUIRED
    'Type' => ['<string>', ...],
]);

Parameter Details

Result Syntax

[
    'ConnectionCredentials' => [
        'ConnectionToken' => '<string>',
        'Expiry' => '<string>',
    ],
    'WebRTCConnection' => [
        'Attendee' => [
            'AttendeeId' => '<string>',
            'JoinToken' => '<string>',
        ],
        'Meeting' => [
            'MediaPlacement' => [
                'AudioFallbackUrl' => '<string>',
                'AudioHostUrl' => '<string>',
                'EventIngestionUrl' => '<string>',
                'SignalingUrl' => '<string>',
            ],
            'MeetingFeatures' => [
                'Audio' => [
                    'EchoReduction' => 'AVAILABLE|UNAVAILABLE',
                ],
            ],
            'MeetingId' => '<string>',
        ],
    ],
    'Websocket' => [
        'ConnectionExpiry' => '<string>',
        'Url' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

DescribeView

$result = $client->describeView([/* ... */]);
$promise = $client->describeViewAsync([/* ... */]);

Retrieves the view for the specified view token.

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

Parameter Syntax

$result = $client->describeView([
    'ConnectionToken' => '<string>', // REQUIRED
    'ViewToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'View' => [
        'Arn' => '<string>',
        'Content' => [
            'Actions' => ['<string>', ...],
            'InputSchema' => '<string>',
            'Template' => '<string>',
        ],
        'Id' => '<string>',
        'Name' => '<string>',
        'Version' => <integer>,
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ResourceNotFoundException:

The resource was not found.

ValidationException:

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

DisconnectParticipant

$result = $client->disconnectParticipant([/* ... */]);
$promise = $client->disconnectParticipantAsync([/* ... */]);

Disconnects a participant.

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

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

Parameter Syntax

$result = $client->disconnectParticipant([
    'ClientToken' => '<string>',
    'ConnectionToken' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

GetAttachment

$result = $client->getAttachment([/* ... */]);
$promise = $client->getAttachmentAsync([/* ... */]);

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

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

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

Parameter Syntax

$result = $client->getAttachment([
    'AttachmentId' => '<string>', // REQUIRED
    'ConnectionToken' => '<string>', // REQUIRED
    'UrlExpiryInSeconds' => <integer>,
]);

Parameter Details

Result Syntax

[
    'AttachmentSizeInBytes' => <integer>,
    'Url' => '<string>',
    'UrlExpiry' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

GetAuthenticationUrl

$result = $client->getAuthenticationUrl([/* ... */]);
$promise = $client->getAuthenticationUrlAsync([/* ... */]);

Retrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block.

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

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

Parameter Syntax

$result = $client->getAuthenticationUrl([
    'ConnectionToken' => '<string>', // REQUIRED
    'RedirectUri' => '<string>', // REQUIRED
    'SessionId' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AuthenticationUrl' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

GetTranscript

$result = $client->getTranscript([/* ... */]);
$promise = $client->getTranscriptAsync([/* ... */]);

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.

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

If you have a process that consumes events in the transcript of an chat that has ended, note that chat transcripts contain the following event content types if the event has occurred during the chat session:

• application/vnd.amazonaws.connect.event.participant.invited

• application/vnd.amazonaws.connect.event.participant.joined

• application/vnd.amazonaws.connect.event.participant.left

• application/vnd.amazonaws.connect.event.chat.ended

• application/vnd.amazonaws.connect.event.transfer.succeeded

• application/vnd.amazonaws.connect.event.transfer.failed

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

Parameter Syntax

$result = $client->getTranscript([
    'ConnectionToken' => '<string>', // REQUIRED
    'ContactId' => '<string>',
    'MaxResults' => <integer>,
    'NextToken' => '<string>',
    'ScanDirection' => 'FORWARD|BACKWARD',
    'SortOrder' => 'DESCENDING|ASCENDING',
    'StartPosition' => [
        'AbsoluteTime' => '<string>',
        'Id' => '<string>',
        'MostRecent' => <integer>,
    ],
]);

Parameter Details

Result Syntax

[
    'InitialContactId' => '<string>',
    'NextToken' => '<string>',
    'Transcript' => [
        [
            'AbsoluteTime' => '<string>',
            'Attachments' => [
                [
                    'AttachmentId' => '<string>',
                    'AttachmentName' => '<string>',
                    'ContentType' => '<string>',
                    'Status' => 'APPROVED|REJECTED|IN_PROGRESS',
                ],
                // ...
            ],
            'ContactId' => '<string>',
            'Content' => '<string>',
            'ContentType' => '<string>',
            'DisplayName' => '<string>',
            'Id' => '<string>',
            'MessageMetadata' => [
                'MessageId' => '<string>',
                'Receipts' => [
                    [
                        'DeliveredTimestamp' => '<string>',
                        'ReadTimestamp' => '<string>',
                        'RecipientParticipantId' => '<string>',
                    ],
                    // ...
                ],
            ],
            'ParticipantId' => '<string>',
            'ParticipantRole' => 'AGENT|CUSTOMER|SYSTEM|CUSTOM_BOT|SUPERVISOR',
            'RelatedContactId' => '<string>',
            'Type' => 'TYPING|PARTICIPANT_JOINED|PARTICIPANT_LEFT|CHAT_ENDED|TRANSFER_SUCCEEDED|TRANSFER_FAILED|MESSAGE|EVENT|ATTACHMENT|CONNECTION_ACK|MESSAGE_DELIVERED|MESSAGE_READ',
        ],
        // ...
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

SendEvent

$result = $client->sendEvent([/* ... */]);
$promise = $client->sendEventAsync([/* ... */]);

The application/vnd.amazonaws.connect.event.connection.acknowledged ContentType is no longer maintained since December 31, 2024. This event has been migrated to the CreateParticipantConnection API using the ConnectParticipant field.

Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception.

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

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

Parameter Syntax

$result = $client->sendEvent([
    'ClientToken' => '<string>',
    'ConnectionToken' => '<string>', // REQUIRED
    'Content' => '<string>',
    'ContentType' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AbsoluteTime' => '<string>',
    'Id' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ConflictException:

The requested operation conflicts with the current state of a service resource associated with the request.

SendMessage

$result = $client->sendMessage([/* ... */]);
$promise = $client->sendMessageAsync([/* ... */]);

Sends a message.

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

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

Parameter Syntax

$result = $client->sendMessage([
    'ClientToken' => '<string>',
    'ConnectionToken' => '<string>', // REQUIRED
    'Content' => '<string>', // REQUIRED
    'ContentType' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AbsoluteTime' => '<string>',
    'Id' => '<string>',
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

StartAttachmentUpload

$result = $client->startAttachmentUpload([/* ... */]);
$promise = $client->startAttachmentUploadAsync([/* ... */]);

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

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

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

Parameter Syntax

$result = $client->startAttachmentUpload([
    'AttachmentName' => '<string>', // REQUIRED
    'AttachmentSizeInBytes' => <integer>, // REQUIRED
    'ClientToken' => '<string>', // REQUIRED
    'ConnectionToken' => '<string>', // REQUIRED
    'ContentType' => '<string>', // REQUIRED
]);

Parameter Details

Result Syntax

[
    'AttachmentId' => '<string>',
    'UploadMetadata' => [
        'HeadersToInclude' => ['<string>', ...],
        'Url' => '<string>',
        'UrlExpiry' => '<string>',
    ],
]

Result Details

Errors

AccessDeniedException:

You do not have sufficient access to perform this action.

InternalServerException:

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

ThrottlingException:

The request was denied due to request throttling.

ValidationException:

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

ServiceQuotaExceededException:

The number of attachments per contact exceeds the quota.