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

SendMessage

Submits a message to the Amazon Q in Connect session.

Request Syntax


POST /assistants/assistantId/sessions/sessionId/message HTTP/1.1
Content-type: application/json

{
   "clientToken": "string",
   "conversationContext": { 
      "selfServiceConversationHistory": [ 
         { 
            "botResponse": "string",
            "inputTranscript": "string",
            "turnNumber": number
         }
      ]
   },
   "message": { 
      "value": { ... }
   },
   "type": "string"
}

URI Request Parameters

The request uses the following URI parameters.

assistantId

The identifier of the Amazon Q in Connect assistant.

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$|^arn:[a-z-]*?:wisdom:[a-z0-9-]*?:[0-9]{12}:[a-z-]*?/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(?:/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}){0,2}$

Required: Yes

sessionId

The identifier of the Amazon Q in Connect session.

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: Minimum length of 1. Maximum length of 4096.

Required: No

conversationContext

The conversation context before the Amazon Q in Connect session.

Type: ConversationContext object

Required: No

message

The message data to submit to the Amazon Q in Connect session.

Type: MessageInput object

Required: Yes

type

The message type.

Type: String

Valid Values: TEXT

Required: Yes

Response Syntax


HTTP/1.1 200
Content-type: application/json

{
   "nextMessageToken": "string",
   "requestMessageId": "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.

nextMessageToken

The token for the next message, used by GetNextMessage.

Type: String

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

requestMessageId

The identifier of the submitted message.

Type: String

Pattern: ^[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}$

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 request could not be processed because of conflict in the current state of the resource. For example, if you're using a Create API (such as CreateAssistant) that accepts name, a conflicting resource (usually with the same name) is being created or mutated.

HTTP Status Code: 409

RequestTimeoutException

The request reached the service more than 15 minutes after the date stamp on the request or more than 15 minutes after the request expiration date (such as for pre-signed URLs), or the date stamp on the request is more than 15 minutes in the future.

HTTP Status Code: 408

ResourceNotFoundException

The specified resource does not exist.

HTTP Status Code: 404

ThrottlingException

The throttling limit has been exceeded.

HTTP Status Code: 400

ValidationException

The input fails to satisfy the constraints specified by a service.

HTTP Status Code: 400