View Source aws_connectparticipant (aws v1.0.4)
Amazon Connect is an easy-to-use omnichannel cloud contact center service that enables companies of any size to deliver superior customer service at a lower cost.
Amazon Connect communications capabilities make it easy for companies to deliver personalized interactions across communication channels, including chat.
Use the Amazon Connect Participant Service to manage participants (for example, agents, customers, and managers listening in), and to send messages and events within a chat contact. The APIs in the service enable the following: sending chat messages, attachment sharing, managing a participant's connection state and message events, and retrieving chat transcripts.Summary
Functions
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
Creates the participant's connection.
Disconnects a participant.
Provides a pre-signed URL for download of a completed attachment.
Retrieves a transcript of the session, including details about any attachments.
The application/vnd.amazonaws.connect.event.connection.acknowledged
ContentType will no longer be supported starting December 31, 2024.
Sends a message.
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
Functions
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.
ConnectionToken
is used for invoking this API instead of ParticipantToken
.
Creates the participant's connection.
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: https://docs.aws.amazon.com/connect/latest/APIReference/API_StartContactStreaming.html 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: https://docs.aws.amazon.com/connect/latest/adminguide/chat-message-streaming.html 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: https://docs.aws.amazon.com/connect/latest/adminguide/amazon-connect-service-limits.html#feature-limits in the Amazon Connect Administrator Guide.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication: https://docs.aws.amazon.com/general/latest/gr/signature-version-4.html.describe_view(Client, ViewToken, ConnectionToken, QueryMap, HeadersMap)
View Sourcedescribe_view(Client, ViewToken, ConnectionToken, QueryMap, HeadersMap, Options0)
View SourceDisconnects a participant.
ConnectionToken
is used for invoking this API instead of ParticipantToken
.
Provides a pre-signed URL for download of a completed attachment.
This is an asynchronous API for use with active contacts.
ConnectionToken
is used for invoking this API instead of ParticipantToken
.
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: https://docs.aws.amazon.com/connect/latest/adminguide/chat-persistence.html.
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.left
application/vnd.amazonaws.connect.event.participant.joined
application/vnd.amazonaws.connect.event.chat.ended
application/vnd.amazonaws.connect.event.transfer.succeeded
application/vnd.amazonaws.connect.event.transfer.failed
ConnectionToken
is used for invoking this API instead of ParticipantToken
.
The application/vnd.amazonaws.connect.event.connection.acknowledged
ContentType will no longer be supported starting December 31, 2024.
This event has been migrated to the CreateParticipantConnection: https://docs.aws.amazon.com/connect-participant/latest/APIReference/API_CreateParticipantConnection.html 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.
ConnectionToken
is used for invoking this API instead of ParticipantToken
.
Sends a message.
ConnectionToken
is used for invoking this API instead of ParticipantToken
.
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
ConnectionToken
is used for invoking this API instead of ParticipantToken
.