* 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. *
**/ public interface AmazonConnectParticipant { /** * Overrides the default endpoint for this client * ("https://participant.connect.us-east-1.amazonaws.com"). Callers can use * this method to control which AWS region they want to work with. ** Callers can pass in just the endpoint (ex: * "participant.connect.us-east-1.amazonaws.com") or a full URL, including * the protocol (ex: "https://participant.connect.us-east-1.amazonaws.com"). * If the protocol is not specified here, the default protocol from this * client's {@link ClientConfiguration} will be used, which by default is * HTTPS. *
* For more information on using AWS regions with the AWS SDK for Java, and * a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= * 3912 *
* This method is not threadsafe. An endpoint should be configured when * the client is created and before any service requests are made. Changing * it afterwards creates inevitable race conditions for any service requests * in transit or retrying. * * @param endpoint The endpoint (ex: * "participant.connect.us-east-1.amazonaws.com") or a full URL, * including the protocol (ex: * "https://participant.connect.us-east-1.amazonaws.com") of the * region specific AWS endpoint this client will communicate * with. * @throws IllegalArgumentException If any problems are detected with the * specified endpoint. */ public void setEndpoint(String endpoint) throws java.lang.IllegalArgumentException; /** * An alternative to {@link AmazonConnectParticipant#setEndpoint(String)}, * sets the regional endpoint for this client's service calls. Callers can * use this method to control which AWS region they want to work with. *
* By default, all service endpoints in all regions use the https protocol. * To use http instead, specify it in the {@link ClientConfiguration} * supplied at construction. *
* This method is not threadsafe. A region should be configured when the * client is created and before any service requests are made. Changing it * afterwards creates inevitable race conditions for any service requests in * transit or retrying. * * @param region The region this client will communicate with. See * {@link Region#getRegion(com.amazonaws.regions.Regions)} for * accessing a given region. * @throws java.lang.IllegalArgumentException If the given region is null, * or if this service isn't available in the given region. See * {@link Region#isServiceSupported(String)} * @see Region#getRegion(com.amazonaws.regions.Regions) * @see Region#createClient(Class, * com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration) */ public void setRegion(Region region) throws java.lang.IllegalArgumentException; /** *
* Allows you to confirm that the attachment has been uploaded using the * pre-signed URL provided in StartAttachmentUpload API. *
*
* ConnectionToken is used for invoking this API instead of
* ParticipantToken.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param completeAttachmentUploadRequest * @return completeAttachmentUploadResult The response from the * CompleteAttachmentUpload service method, as returned by Amazon * Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws ServiceQuotaExceededException * @throws ConflictException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ CompleteAttachmentUploadResult completeAttachmentUpload( CompleteAttachmentUploadRequest completeAttachmentUploadRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
** 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. *
* * @param disconnectParticipantRequest * @return disconnectParticipantResult The response from the * DisconnectParticipant service method, as returned by Amazon * Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ DisconnectParticipantResult disconnectParticipant( DisconnectParticipantRequest disconnectParticipantRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param getAttachmentRequest * @return getAttachmentResult The response from the GetAttachment service * method, as returned by Amazon Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ GetAttachmentResult getAttachment(GetAttachmentRequest getAttachmentRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
*
* ConnectionToken is used for invoking this API instead of
* ParticipantToken.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param getTranscriptRequest * @return getTranscriptResult The response from the GetTranscript service * method, as returned by Amazon Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ GetTranscriptResult getTranscript(GetTranscriptRequest getTranscriptRequest) throws AmazonClientException, AmazonServiceException; /** ** Sends an event. *
*
* ConnectionToken is used for invoking this API instead of
* ParticipantToken.
*
* The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication. *
* * @param sendEventRequest * @return sendEventResult The response from the SendEvent service method, * as returned by Amazon Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ SendEventResult sendEvent(SendEventRequest sendEventRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param sendMessageRequest * @return sendMessageResult The response from the SendMessage service * method, as returned by Amazon Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ SendMessageResult sendMessage(SendMessageRequest sendMessageRequest) throws AmazonClientException, AmazonServiceException; /** ** 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. *
* * @param startAttachmentUploadRequest * @return startAttachmentUploadResult The response from the * StartAttachmentUpload service method, as returned by Amazon * Connect Participant. * @throws AccessDeniedException * @throws InternalServerException * @throws ThrottlingException * @throws ValidationException * @throws ServiceQuotaExceededException * @throws AmazonClientException If any internal errors are encountered * inside the client while attempting to make the request or * handle the response. For example if a network connection is * not available. * @throws AmazonServiceException If an error response is returned by Amazon * Connect Participant indicating either a problem with the data * in the request, or a server side issue. */ StartAttachmentUploadResult startAttachmentUpload( StartAttachmentUploadRequest startAttachmentUploadRequest) throws AmazonClientException, AmazonServiceException; /** * Shuts down this client object, releasing any resources that might be held * open. This is an optional method, and callers are not expected to call * it, but can if they want to explicitly release any open resources. Once a * client has been shutdown, it should not be used to make any more * requests. */ public void shutdown(); /** * Returns additional metadata for a previously executed successful request, * typically used for debugging issues where a service isn't acting as * expected. This data isn't considered part of the result data returned by * an operation, so it's available through this separate, diagnostic * interface. ** 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. * * @param request The originally executed request. * @return The response metadata for the specified request, or null if none * is available. */ public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request); }