Get conversation messages
Changed onRetrieve messages in a conversation, sorted in the specified order, up to the specified limit.
Permissions
This endpoint is impacted by the following permissions:
- Only messages that the authenticated user has Conversation.GetMessage permission on will be returned.
Request
- Base URLhttps://api.amigo.ai
- AuthHTTP bearer and API key in header X-ORG-ID and HTTP basic
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
The identifier of the conversation.
Query parameters
The IDs of the messages to retrieve.
The type of messages to retrieve.
The IDs of the interactions to retrieve messages for.
The maximum number of messages to return. At most 500 messages can be returned in one request.
The continuation token to use to retrieve the next set of messages.
The field to sort the messages by. Supported fields are interaction_id and created_at. Specify a + before the field name to indicate ascending sorting and - for descending sorting. Multiple fields can be specified to break ties.
Headers
The Mongo cluster name to perform this request in. This is usually not needed unless the organization does not exist yet in the Amigo organization infra config database.
Response
Succeeded.
Changes
- breaking
for the
queryrequest parametermessage_type, default value was changed fromexternal-eventuser-messageagent-messagetoagent-messageexternal-eventuser-message
- breaking
- breaking
for the
queryrequest parametermessage_type, default value was changed fromagent-messageuser-messageexternal-eventtoexternal-eventuser-messageagent-message
- breaking