List Messages

get

{protocol}://{server}{basePath}/accounts/{accountId}/engagements/{engagementId}/messages

Retrieve transcript messages for all dialogs or specified dialog of a given engagement.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

accountId

string

required

length between 6 and 6

The unique 6 character internal id that represents the customer account.

engagementId

string

required

length between 36 and 36

The unique 36 character internal id that represents the engagement.

Query Params

dialogId

string

length between 1 and 100

The unique 1-100 characters internal id that represents the Dialog.

pageNumber

int32

≥ 1

Defaults to 1

The target page of results.

pageSize

int32

1 to 50

Defaults to 10

The maximum number of results per page.

orderBy

string

length ≤ 50

Defaults to messageReceivedTimestamp

Field used to order messages. Currently, only the 'messageReceivedTimestamp' field is supported for ordering.

order

string

length between 3 and 4

Defaults to ASC

The sorting order for messages using the orderBy field. Valid values are DESC (descending) or ASC (ascending)

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

Credentials

URL

Loading…

Response

Choose an example:

application/json

application/problem+json

200OK

400Bad Request. accountId must be exactly 6 characters pageNumber must be greater than 0 pageSize must be between 1 and 50 engagementIds must be 36 character UUIDs

401Unauthorized.

403Forbidden.

404Not Found.

429Too Many Requests

500Internal Server Error