@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public interface AmazonConnectParticipant
Note: Do not directly implement this interface, new methods are added to it regularly. Extend from
AbstractAmazonConnectParticipant instead.
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.
| Modifier and Type | Field and Description |
|---|---|
static String |
ENDPOINT_PREFIX
The region metadata service name for computing region endpoints.
|
| Modifier and Type | Method and Description |
|---|---|
CompleteAttachmentUploadResult |
completeAttachmentUpload(CompleteAttachmentUploadRequest completeAttachmentUploadRequest)
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in
StartAttachmentUpload API.
|
CreateParticipantConnectionResult |
createParticipantConnection(CreateParticipantConnectionRequest createParticipantConnectionRequest)
Creates the participant's connection.
|
DescribeViewResult |
describeView(DescribeViewRequest describeViewRequest)
Retrieves the view for the specified view token.
|
DisconnectParticipantResult |
disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a participant.
|
GetAttachmentResult |
getAttachment(GetAttachmentRequest getAttachmentRequest)
Provides a pre-signed URL for download of a completed attachment.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetTranscriptResult |
getTranscript(GetTranscriptRequest getTranscriptRequest)
Retrieves a transcript of the session, including details about any attachments.
|
SendEventResult |
sendEvent(SendEventRequest sendEventRequest)
|
SendMessageResult |
sendMessage(SendMessageRequest sendMessageRequest)
Sends a message.
|
void |
shutdown()
Shuts down this client object, releasing any resources that might be held open.
|
StartAttachmentUploadResult |
startAttachmentUpload(StartAttachmentUploadRequest startAttachmentUploadRequest)
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
|
static final String ENDPOINT_PREFIX
CompleteAttachmentUploadResult completeAttachmentUpload(CompleteAttachmentUploadRequest completeAttachmentUploadRequest)
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.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
completeAttachmentUploadRequest - 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.CreateParticipantConnectionResult createParticipantConnection(CreateParticipantConnectionRequest createParticipantConnectionRequest)
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 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.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
createParticipantConnectionRequest - 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.DescribeViewResult describeView(DescribeViewRequest describeViewRequest)
Retrieves the view for the specified view token.
describeViewRequest - 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.DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest)
Disconnects a participant.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
disconnectParticipantRequest - 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.GetAttachmentResult getAttachment(GetAttachmentRequest getAttachmentRequest)
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.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
getAttachmentRequest - 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.GetTranscriptResult getTranscript(GetTranscriptRequest getTranscriptRequest)
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.
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 Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
getTranscriptRequest - 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.SendEventResult sendEvent(SendEventRequest sendEventRequest)
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 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.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
sendEventRequest - 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.SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)
Sends a message.
ConnectionToken is used for invoking this API instead of ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
sendMessageRequest - 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.StartAttachmentUploadResult startAttachmentUpload(StartAttachmentUploadRequest startAttachmentUploadRequest)
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.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
startAttachmentUploadRequest - 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.void shutdown()
ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
request - The originally executed request.