aws_connectparticipant
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.Summary
Functions
-
complete_attachment_upload(Client, Input)
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
- complete_attachment_upload(Client, Input0, Options0)
-
create_participant_connection(Client, Input)
Creates the participant's connection.
- create_participant_connection(Client, Input0, Options0)
-
disconnect_participant(Client, Input)
Disconnects a participant.
- disconnect_participant(Client, Input0, Options0)
-
get_attachment(Client, Input)
Provides a pre-signed URL for download of a completed attachment.
- get_attachment(Client, Input0, Options0)
-
get_transcript(Client, Input)
Retrieves a transcript of the session, including details about any attachments.
- get_transcript(Client, Input0, Options0)
-
send_event(Client, Input)
Sends an event.
- send_event(Client, Input0, Options0)
-
send_message(Client, Input)
Sends a message.
- send_message(Client, Input0, Options0)
-
start_attachment_upload(Client, Input)
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
- start_attachment_upload(Client, Input0, Options0)
Functions
complete_attachment_upload(Client, Input)
Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
complete_attachment_upload(Client, Input0, Options0)
create_participant_connection(Client, Input)
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.create_participant_connection(Client, Input0, Options0)
disconnect_participant(Client, Input)
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.disconnect_participant(Client, Input0, Options0)
get_attachment(Client, Input)
Provides a pre-signed URL for download of a completed attachment.
This is an asynchronous API for use with active contacts.get_attachment(Client, Input0, Options0)
get_transcript(Client, Input)
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.get_transcript(Client, Input0, Options0)
send_event(Client, Input)
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.send_event(Client, Input0, Options0)
send_message(Client, Input)
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.send_message(Client, Input0, Options0)
start_attachment_upload(Client, Input)
Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.