SendEvent
Note
The application/vnd.amazonaws.connect.event.connection.acknowledged
ContentType will no longer be supported starting December 31, 2024. This event has
been migrated to the CreateParticipantConnection API using the
ConnectParticipant field.
Sends an event. Message receipts are not supported when there are more than two active participants in the chat. Using the SendEvent API for message receipts when a supervisor is barged-in will result in a conflict exception.
For security recommendations, see Amazon Connect Chat security best practices.
Note
ConnectionToken is used for invoking this API instead of
ParticipantToken.
The Amazon Connect Participant Service APIs do not use Signature Version 4 authentication.
Request Syntax
POST /participant/event HTTP/1.1
X-Amz-Bearer: ConnectionToken
Content-type: application/json
{
"ClientToken": "string",
"Content": "string",
"ContentType": "string"
}URI Request Parameters
The request uses the following URI parameters.
- ConnectionToken
-
The authentication token associated with the participant's connection.
Length Constraints: Minimum length of 1. Maximum length of 1000.
Required: Yes
Request Body
The request accepts the following data in JSON format.
- ClientToken
-
A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. If not provided, the AWS SDK populates this field. For more information about idempotency, see Making retries safe with idempotent APIs
. Type: String
Length Constraints: Maximum length of 500.
Required: No
- Content
-
The content of the event to be sent (for example, message text). For content related to message receipts, this is supported in the form of a JSON string.
Sample Content: "{\"messageId\":\"11111111-aaaa-bbbb-cccc-EXAMPLE01234\"}"
Type: String
Length Constraints: Minimum length of 1. Maximum length of 16384.
Required: No
- ContentType
-
The content type of the request. Supported types are:
-
application/vnd.amazonaws.connect.event.typing
-
application/vnd.amazonaws.connect.event.connection.acknowledged (will be deprecated on December 31, 2024)
-
application/vnd.amazonaws.connect.event.message.delivered
-
application/vnd.amazonaws.connect.event.message.read
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
Required: Yes
-
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"AbsoluteTime": "string",
"Id": "string"
}Response Elements
If the action is successful, the service sends back an HTTP 200 response.
The following data is returned in JSON format by the service.
- 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.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 100.
- Id
-
The ID of the response.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 256.
Errors
For information about the errors that are common to all actions, see Common Errors.
- AccessDeniedException
-
You do not have sufficient access to perform this action.
HTTP Status Code: 403
- ConflictException
-
The requested operation conflicts with the current state of a service resource associated with the request.
HTTP Status Code: 409
- InternalServerException
-
This exception occurs when there is an internal failure in the Amazon Connect service.
HTTP Status Code: 500
- ThrottlingException
-
The request was denied due to request throttling.
HTTP Status Code: 429
- ValidationException
-
The input fails to satisfy the constraints specified by Amazon Connect.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
