AWS.ConnectParticipant (aws-elixir v0.8.0) View Source

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.

Link to this section 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.

Provides a pre-signed URL for download of a completed attachment.

Retrieves a transcript of the session, including details about any attachments.

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

Link to this section Functions

Link to this function

complete_attachment_upload(client, input, options \\ [])

View Source

Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.

Link to this function

create_participant_connection(client, input, options \\ [])

View Source

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

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

Link to this function

disconnect_participant(client, input, options \\ [])

View Source

Disconnects a participant.

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

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

Link to this function

get_attachment(client, input, options \\ [])

View Source

Provides a pre-signed URL for download of a completed attachment.

This is an asynchronous API for use with active contacts.

Link to this function

get_transcript(client, input, options \\ [])

View Source

Retrieves a transcript of the session, including details about any attachments.

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

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

Link to this function

send_event(client, input, options \\ [])

View Source

Sends an event.

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

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

Link to this function

send_message(client, input, options \\ [])

View Source

Sends a message.

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

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

Link to this function

start_attachment_upload(client, input, options \\ [])

View Source

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