Amazon Connect Participant Service
Participant Service actions Participant Service data types Use the Connect Customer Participant Service to manage participants (for example, agents,…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Participant Service actions
Participant Service data types
Use the Connect Customer 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.
Endpoints 11
- POSTCancel participant authentication
/participant/cancel-authenticationCancels the authentication session. The opted out branch of the Authenticate Customer flow block will be taken. The current supported channel is chat. This… - POSTComplete attachment upload
/participant/complete-attachment-uploadAllows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API. A conflict exception is thrown… - POSTCreate participant connection
/participant/connectionCreates the participant's connection. For security recommendations, see Connect Customer Chat security best practices . For WebRTC security recommendations,… - GETDescribe view
/participant/views/:ViewTokenRetrieves the view for the specified view token. For security recommendations, see Connect Customer Chat security best practices . - POSTDisconnect participant
/participant/disconnectDisconnects a participant. For security recommendations, see Connect Customer Chat security best practices . ConnectionToken is used for invoking this API… - POSTGet attachment
/participant/attachmentProvides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts. For security recommendations, see… - POSTGet authentication url
/participant/authentication-urlRetrieves the AuthenticationUrl for the current authentication session for the AuthenticateCustomer flow block. For security recommendations, see Connect… - POSTGet transcript
/participant/transcriptRetrieves a transcript of the session, including details about any attachments. For information about accessing past chat contact transcripts for a persistent… - POSTSend event
/participant/eventThe application/vnd.amazonaws.connect.event.connection.acknowledged ContentType is no longer maintained since December 31, 2024. This event has been migrated… - POSTSend message
/participant/messageSends a message. For security recommendations, see Connect Customer Chat security best practices . ConnectionToken is used for invoking this API instead of… - POSTStart attachment upload
/participant/start-attachment-uploadProvides a pre-signed Amazon S3 URL in response for uploading the file directly to S3. For security recommendations, see Connect Customer Chat security best…
API details
- Base URL
https://participant.connect.{region}.amazonaws.com- Authentication
- AWS Signature Version 4 (requests signed with your AWS access key)
- Operations
- 11 operations on 11 pathsPOST 10GET 1
- Description format
- AWS Smithy model, API version
2018-09-07 - Links
- Documentation · OpenAPI document
- Listed from
- AWS Smithy API model (aws/api-models-aws) (Apache-2.0)
How to test the Amazon Connect Participant Service in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Amazon Connect Participant Service collection, without the publisher's secrets.
- Add your credentialsThis API uses AWS Signature Version 4 (requests signed with your AWS access key). Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “Cancel participant authentication” (POST /participant/cancel-authentication), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Amazon Connect Participant Service?
Participant Service actions Participant Service data types Use the Connect Customer Participant Service to manage participants (for example, agents,… It is listed under Communication and has 11 endpoints.
Who publishes the Amazon Connect Participant Service?
It is listed from Amazon Web Services, Inc.'s public API description (an OpenAPI document), not published by Amazon Web Services, Inc. on Swastik Codes. Anyone who controls amazonaws.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Amazon Connect Participant Service?
Requests go to https://participant.connect.{region}.amazonaws.com. Endpoint paths are added to this base URL.
How do I authenticate with the Amazon Connect Participant Service?
With AWS Signature Version 4 (requests signed with your AWS access key).
How many endpoints does the Amazon Connect Participant Service have?
11 operations on 11 paths (10 POST, 1 GET).
Is forking the Amazon Connect Participant Service free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.