Request Syntax URI Request Parameters Request Body Response Syntax Response Elements Errors See Also

SendMessage

Sends a message.

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/message 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 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 message.

For text/plain and text/markdown, the Length Constraints are Minimum of 1, Maximum of 1024.
For application/json, the Length Constraints are Minimum of 1, Maximum of 12000.
For application/vnd.amazonaws.connect.message.interactive.response, the Length Constraints are Minimum of 1, Maximum of 12288.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 1024.

Required: Yes

ContentType

The type of the content. Supported types are text/plain, text/markdown, application/json, and application/vnd.amazonaws.connect.message.interactive.response.

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 message 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 message.

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

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