com.amazonaws.services.connectparticipant

Interface AmazonConnectParticipant

All Known Subinterfaces:

AmazonConnectParticipantAsync

All Known Implementing Classes:

AbstractAmazonConnectParticipant, AbstractAmazonConnectParticipantAsync, AmazonConnectParticipantAsyncClient, AmazonConnectParticipantClient

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public interface AmazonConnectParticipant

Interface for accessing Amazon Connect Participant.

Note: Do not directly implement this interface, new methods are added to it regularly. Extend from AbstractAmazonConnectParticipant instead.

Amazon Connect is a cloud-based contact center solution that makes it easy to set up and manage a customer contact center and provide reliable customer engagement at any scale.

Amazon Connect enables customer contacts through voice or chat.

The APIs described here are used by chat participants, such as agents and customers.

Field Summary

Fields

Modifier and Type	Field and Description
static String	ENDPOINT_PREFIX The region metadata service name for computing region endpoints.

Method Summary

Modifier and Type	Method and Description
CreateParticipantConnectionResult	createParticipantConnection(CreateParticipantConnectionRequest createParticipantConnectionRequest) Creates the participant's connection.
DisconnectParticipantResult	disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest) Disconnects a participant.
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.
SendEventResult	sendEvent(SendEventRequest sendEventRequest) Sends an event.
SendMessageResult	sendMessage(SendMessageRequest sendMessageRequest) Sends a message.
void	shutdown() Shuts down this client object, releasing any resources that might be held open.

Field Detail

ENDPOINT_PREFIX

static final String ENDPOINT_PREFIX

The region metadata service name for computing region endpoints. You can use this value to retrieve metadata (such as supported regions) of the service.

See Also:

RegionUtils.getRegionsForService(String), Constant Field Values

Method Detail

createParticipantConnection

CreateParticipantConnectionResult createParticipantConnection(CreateParticipantConnectionRequest createParticipantConnectionRequest)

Creates the participant's connection. Note that ParticipantToken is used for invoking this API instead of ConnectionToken.

The participant token is valid for the lifetime of the participant – until the 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.

Parameters:

createParticipantConnectionRequest -

Returns:

Result of the CreateParticipantConnection operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

disconnectParticipant

DisconnectParticipantResult disconnectParticipant(DisconnectParticipantRequest disconnectParticipantRequest)

Disconnects a participant. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Parameters:

disconnectParticipantRequest -

Returns:

Result of the DisconnectParticipant operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

getTranscript

GetTranscriptResult getTranscript(GetTranscriptRequest getTranscriptRequest)

Retrieves a transcript of the session. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Parameters:

getTranscriptRequest -

Returns:

Result of the GetTranscript operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

sendEvent

SendEventResult sendEvent(SendEventRequest sendEventRequest)

Sends an event. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Parameters:

sendEventRequest -

Returns:

Result of the SendEvent operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

sendMessage

SendMessageResult sendMessage(SendMessageRequest sendMessageRequest)

Sends a message. Note that ConnectionToken is used for invoking this API instead of ParticipantToken.

Parameters:

sendMessageRequest -

Returns:

Result of the SendMessage operation returned by the service.

Throws:

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.

See Also:

AWS API Documentation

shutdown

void shutdown()

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.

getCachedResponseMetadata

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. 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.

Parameters:

request - The originally executed request.

Returns:

The response metadata for the specified request, or null if none is available.