APIHub
Back to Explore

Amazon Connect Participant Service

<p>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. </p> <p>Use the Amazon Connect Participant Service to manage participants (for e

Cloud
apiKeyHeader
No HTTPS
CORS: Unknown
Visit official documentation

Latency

Not monitored yet

Uptime

Not monitored yet

Playground

Verified

live

Endpoints

REST · JSON
POST

/participant/complete-attachment-upload#X-Amz-Bearer

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 .

  • X-Amz-Bearer (header, required) — The authentication token associated with the participant's connection.
POST

/participant/connection#X-Amz-Bearer

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 .

  • X-Amz-Bearer (header, required) — This is a header parameter. The ParticipantToken as obtained from StartChatContact API response.
POST

/participant/disconnect#X-Amz-Bearer

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 .

  • X-Amz-Bearer (header, required) — The authentication token associated with the participant's connection.
POST

/participant/attachment#X-Amz-Bearer

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 .

  • X-Amz-Bearer (header, required) — The authentication token associated with the participant's connection.
POST

/participant/transcript#X-Amz-Bearer

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 .

  • X-Amz-Bearer (header, required) — The authentication token associated with the participant's connection.
  • MaxResults (query, limit) — Pagination limit
  • NextToken (query) — Pagination token
POST

/participant/event#X-Amz-Bearer

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 .

  • X-Amz-Bearer (header, required) — The authentication token associated with the participant's connection.
POST

/participant/message#X-Amz-Bearer

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 .

  • X-Amz-Bearer (header, required) — The authentication token associated with the connection.
POST

/participant/start-attachment-upload#X-Amz-Bearer

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 .

  • X-Amz-Bearer (header, required) — The authentication token associated with the participant's connection.

8 endpoints auto-detected

Authentication

This API uses an API key, passed in the "Authorization" header. No OAuth required.

curl -X POST \
  "https://github.com/mermade/aws2openapi/participant/complete-attachment-upload#X-Amz-Bearer" \
  -H "Authorization: YOUR_API_KEY"

github.com · HTTPS only