OmnichannelInstall

Summary

Retrieves messages from a conversation via the Omnichannel Agent API.

Inputs

• conversationId (required) — The unique identifier of the conversation (UUID format)
• returnAll — Whether to return all messages or only a specific page. When enabled, all pages will be fetched automatically.
• limit — Maximum number of messages to return per page (1-100)
• page — Page number to retrieve (starts at 1)

Output shape

When returnAll is false, returns a single page of messages up to the specified limit and page number. When returnAll is true, returns all messages across all pages automatically.

The operation invokes the getMessages action for the message resource and getMany operation. Parameters limit and page are only applicable when returnAll is false.

Examples

Example 1: Fetch the first 20 messages of a conversation

conversationId: UUID, limit: 20, page: 1, returnAll: false