GetNextMessage
Retrieves next message on an Amazon Q in Connect session.
Request Syntax
GET /assistants/assistantId/sessions/sessionId/messages/next?nextMessageToken=nextMessageToken HTTP/1.1
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
- nextMessageToken
-
The token for the next message. Use the value returned in the SendMessage or previous response in the next request to retrieve the next message.
Length Constraints: Minimum length of 1. Maximum length of 2048.
Required: Yes
- sessionId
-
The identifier of the Amazon Q in Connect session.
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
Request Body
The request does not have a request body.
Response Syntax
HTTP/1.1 200
Content-type: application/json
{
"conversationSessionData": [
{
"key": "string",
"value": { ... }
}
],
"conversationState": {
"reason": "string",
"status": "string"
},
"nextMessageToken": "string",
"requestMessageId": "string",
"response": {
"messageId": "string",
"participant": "string",
"timestamp": number,
"value": { ... }
},
"type": "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.
- conversationSessionData
-
The conversation data stored on an Amazon Q in Connect Session.
Type: Array of RuntimeSessionData objects
Array Members: Minimum number of 0 items. Maximum number of 50 items.
- conversationState
-
The state of current conversation.
Type: ConversationState object
- nextMessageToken
-
The token for the next message.
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}$ - response
-
The message response to the requested message.
Type: MessageOutput object
- type
-
The type of message response.
Type: String
Valid Values:
TEXT
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
- ResourceNotFoundException
-
The specified resource does not exist.
HTTP Status Code: 404
- ValidationException
-
The input fails to satisfy the constraints specified by a service.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
