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.
", "operations": { "CompleteAttachmentUpload": "Allows you to confirm that the attachment has been uploaded using the pre-signed URL provided in StartAttachmentUpload API.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
", "CreateParticipantConnection": "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.
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.
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.
", "GetAttachment": "Provides a pre-signed URL for download of a completed attachment. This is an asynchronous API for use with active contacts.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
", "GetTranscript": "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.
", "SendEvent": "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.
", "SendMessage": "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.
", "StartAttachmentUpload": "Provides a pre-signed Amazon S3 URL in response for uploading the file directly to S3.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
" }, "shapes": { "AccessDeniedException": { "base": "You do not have sufficient access to perform this action.
", "refs": { } }, "ArtifactId": { "base": null, "refs": { "AttachmentIdList$member": null, "AttachmentItem$AttachmentId": "A unique identifier for the attachment.
", "GetAttachmentRequest$AttachmentId": "A unique identifier for the attachment.
", "StartAttachmentUploadResponse$AttachmentId": "A unique identifier for the attachment.
" } }, "ArtifactStatus": { "base": null, "refs": { "AttachmentItem$Status": "Status of the attachment.
" } }, "AttachmentIdList": { "base": null, "refs": { "CompleteAttachmentUploadRequest$AttachmentIds": "A list of unique identifiers for the attachments.
" } }, "AttachmentItem": { "base": "The case-insensitive input to indicate standard MIME type that describes the format of the file that will be uploaded.
", "refs": { "Attachments$member": null } }, "AttachmentName": { "base": null, "refs": { "AttachmentItem$AttachmentName": "A case-sensitive name of the attachment being uploaded.
", "StartAttachmentUploadRequest$AttachmentName": "A case-sensitive name of the attachment being uploaded.
" } }, "AttachmentSizeInBytes": { "base": null, "refs": { "StartAttachmentUploadRequest$AttachmentSizeInBytes": "The size of the attachment in bytes.
" } }, "Attachments": { "base": null, "refs": { "Item$Attachments": "Provides information about the attachments.
" } }, "Bool": { "base": null, "refs": { "CreateParticipantConnectionRequest$ConnectParticipant": "Amazon Connect Participant is used to mark the participant as connected for message streaming.
" } }, "ChatContent": { "base": null, "refs": { "Item$Content": "The content of the message or event.
", "SendEventRequest$Content": "The content of the event to be sent (for example, message text). This is not yet supported.
", "SendMessageRequest$Content": "The content of the message.
" } }, "ChatContentType": { "base": null, "refs": { "Item$ContentType": "The type of content of the item.
", "SendEventRequest$ContentType": "The content type of the request. Supported types are:
application/vnd.amazonaws.connect.event.typing
application/vnd.amazonaws.connect.event.connection.acknowledged
The type of the content. Supported types are text/plain.
" } }, "ChatItemId": { "base": null, "refs": { "Item$Id": "The ID of the item.
", "SendEventResponse$Id": "The ID of the response.
", "SendMessageResponse$Id": "The ID of the message.
", "StartPosition$Id": "The ID of the message or event where to start.
" } }, "ChatItemType": { "base": null, "refs": { "Item$Type": "Type of the item: message or event.
" } }, "ClientToken": { "base": null, "refs": { "DisconnectParticipantRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "SendEventRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "SendMessageRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
" } }, "CompleteAttachmentUploadRequest": { "base": null, "refs": { } }, "CompleteAttachmentUploadResponse": { "base": null, "refs": { } }, "ConflictException": { "base": "An attachment with that identifier is already being uploaded.
", "refs": { } }, "ConnectionCredentials": { "base": "Connection credentials.
", "refs": { "CreateParticipantConnectionResponse$ConnectionCredentials": "Creates the participant's connection credentials. The authentication token associated with the participant's connection.
" } }, "ConnectionType": { "base": null, "refs": { "ConnectionTypeList$member": null } }, "ConnectionTypeList": { "base": null, "refs": { "CreateParticipantConnectionRequest$Type": "Type of connection information required.
" } }, "ContactId": { "base": null, "refs": { "GetTranscriptRequest$ContactId": "The contactId from the current contact chain for which transcript is needed.
", "GetTranscriptResponse$InitialContactId": "The initial contact ID for the contact.
" } }, "ContentType": { "base": null, "refs": { "AttachmentItem$ContentType": "Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
", "StartAttachmentUploadRequest$ContentType": "Describes the MIME file type of the attachment. For a list of supported file types, see Feature specifications in the Amazon Connect Administrator Guide.
" } }, "CreateParticipantConnectionRequest": { "base": null, "refs": { } }, "CreateParticipantConnectionResponse": { "base": null, "refs": { } }, "DisconnectParticipantRequest": { "base": null, "refs": { } }, "DisconnectParticipantResponse": { "base": null, "refs": { } }, "DisplayName": { "base": null, "refs": { "Item$DisplayName": "The chat display name of the sender.
" } }, "GetAttachmentRequest": { "base": null, "refs": { } }, "GetAttachmentResponse": { "base": null, "refs": { } }, "GetTranscriptRequest": { "base": null, "refs": { } }, "GetTranscriptResponse": { "base": null, "refs": { } }, "ISO8601Datetime": { "base": null, "refs": { "ConnectionCredentials$Expiry": "The expiration of the token.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
", "GetAttachmentResponse$UrlExpiry": "The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
", "UploadMetadata$UrlExpiry": "The expiration time of the URL in ISO timestamp. It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
", "Websocket$ConnectionExpiry": "The URL expiration timestamp in ISO date format.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" } }, "Instant": { "base": null, "refs": { "Item$AbsoluteTime": "The time when the message or event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
", "SendEventResponse$AbsoluteTime": "The time when the event was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
", "SendMessageResponse$AbsoluteTime": "The time when the message was sent.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
", "StartPosition$AbsoluteTime": "The time in ISO format where to start.
It's specified in ISO 8601 format: yyyy-MM-ddThh:mm:ss.SSSZ. For example, 2019-11-08T02:41:28.172Z.
" } }, "InternalServerException": { "base": "This exception occurs when there is an internal failure in the Amazon Connect service.
", "refs": { } }, "Item": { "base": "An item - message or event - that has been sent.
", "refs": { "Transcript$member": null } }, "MaxResults": { "base": null, "refs": { "GetTranscriptRequest$MaxResults": "The maximum number of results to return in the page. Default: 10.
" } }, "Message": { "base": null, "refs": { "AccessDeniedException$Message": null, "InternalServerException$Message": null, "ServiceQuotaExceededException$Message": null, "ThrottlingException$Message": null } }, "MostRecent": { "base": null, "refs": { "StartPosition$MostRecent": "The start position of the most recent message where you want to start.
" } }, "NextToken": { "base": null, "refs": { "GetTranscriptRequest$NextToken": "The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
", "GetTranscriptResponse$NextToken": "The pagination token. Use the value returned previously in the next subsequent request to retrieve the next set of results.
" } }, "NonEmptyClientToken": { "base": null, "refs": { "CompleteAttachmentUploadRequest$ClientToken": "A unique, case-sensitive identifier that you provide to ensure the idempotency of the request.
", "StartAttachmentUploadRequest$ClientToken": "A unique case sensitive identifier to support idempotency of request.
" } }, "ParticipantId": { "base": null, "refs": { "Item$ParticipantId": "The ID of the sender in the session.
" } }, "ParticipantRole": { "base": null, "refs": { "Item$ParticipantRole": "The role of the sender. For example, is it a customer, agent, or system.
" } }, "ParticipantToken": { "base": null, "refs": { "CompleteAttachmentUploadRequest$ConnectionToken": "The authentication token associated with the participant's connection.
", "ConnectionCredentials$ConnectionToken": "The connection token.
", "CreateParticipantConnectionRequest$ParticipantToken": "This is a header parameter.
The ParticipantToken as obtained from StartChatContact API response.
", "DisconnectParticipantRequest$ConnectionToken": "The authentication token associated with the participant's connection.
", "GetAttachmentRequest$ConnectionToken": "The authentication token associated with the participant's connection.
", "GetTranscriptRequest$ConnectionToken": "The authentication token associated with the participant's connection.
", "SendEventRequest$ConnectionToken": "The authentication token associated with the participant's connection.
", "SendMessageRequest$ConnectionToken": "The authentication token associated with the connection.
", "StartAttachmentUploadRequest$ConnectionToken": "The authentication token associated with the participant's connection.
" } }, "PreSignedAttachmentUrl": { "base": null, "refs": { "GetAttachmentResponse$Url": "This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.
" } }, "PreSignedConnectionUrl": { "base": null, "refs": { "Websocket$Url": "The URL of the websocket.
" } }, "Reason": { "base": null, "refs": { "ConflictException$Message": null, "ValidationException$Message": null } }, "ScanDirection": { "base": null, "refs": { "GetTranscriptRequest$ScanDirection": "The direction from StartPosition from which to retrieve message. Default: BACKWARD when no StartPosition is provided, FORWARD with StartPosition.
" } }, "SendEventRequest": { "base": null, "refs": { } }, "SendEventResponse": { "base": null, "refs": { } }, "SendMessageRequest": { "base": null, "refs": { } }, "SendMessageResponse": { "base": null, "refs": { } }, "ServiceQuotaExceededException": { "base": "The number of attachments per contact exceeds the quota.
", "refs": { } }, "SortKey": { "base": null, "refs": { "GetTranscriptRequest$SortOrder": "The sort order for the records. Default: DESCENDING.
" } }, "StartAttachmentUploadRequest": { "base": null, "refs": { } }, "StartAttachmentUploadResponse": { "base": null, "refs": { } }, "StartPosition": { "base": "A filtering option for where to start. For example, if you sent 100 messages, start with message 50.
", "refs": { "GetTranscriptRequest$StartPosition": "A filtering option for where to start.
" } }, "ThrottlingException": { "base": "The request was denied due to request throttling.
", "refs": { } }, "Transcript": { "base": null, "refs": { "GetTranscriptResponse$Transcript": "The list of messages in the session.
" } }, "UploadMetadata": { "base": "Fields to be used while uploading the attachment.
", "refs": { "StartAttachmentUploadResponse$UploadMetadata": "Fields to be used while uploading the attachment.
" } }, "UploadMetadataSignedHeaders": { "base": null, "refs": { "UploadMetadata$HeadersToInclude": "The headers to be provided while uploading the file to the URL.
" } }, "UploadMetadataSignedHeadersKey": { "base": null, "refs": { "UploadMetadataSignedHeaders$key": null } }, "UploadMetadataSignedHeadersValue": { "base": null, "refs": { "UploadMetadataSignedHeaders$value": null } }, "UploadMetadataUrl": { "base": null, "refs": { "UploadMetadata$Url": "This is the pre-signed URL that can be used for uploading the file to Amazon S3 when used in response to StartAttachmentUpload.
" } }, "ValidationException": { "base": "The input fails to satisfy the constraints specified by Amazon Connect.
", "refs": { } }, "Websocket": { "base": "The websocket for the participant's connection.
", "refs": { "CreateParticipantConnectionResponse$Websocket": "Creates the participant's websocket connection.
" } } } }