Specifies the maximum number of results to include per page, enabling pagination. The value must be between 1 and 100, inclusive.
For example, if page_size
is set to 10, each page will include up to 10 items. Defaults to 10.
Specifies the page number to retrieve, enabling pagination.
This parameter uses zero-based indexing. For example, setting page_number
to 0 retrieves the first page of results (items 0-9 if page_size
is 10), setting page_number
to 1 retrieves the second page (items 10-19), and so on. Defaults to 0, which retrieves the first page.
Identifier for the Chat Group. Any chat resumed from this Chat will have the same chat_group_id
. Formatted as a UUID.
Indicates the current state of the chat. There are six possible statuses:
ACTIVE
: The chat is currently active and ongoing.
USER_ENDED
: The chat was manually ended by the user.
USER_TIMEOUT
: The chat ended due to a user-defined timeout.
MAX_DURATION_TIMEOUT
: The chat ended because it reached the maximum allowed duration.
INACTIVITY_TIMEOUT
: The chat ended due to an inactivity timeout.
ERROR
: The chat ended unexpectedly due to an error.
Indicates the order in which the paginated results are presented, based on their creation date.
It shows ASC
for ascending order (chronological, with the oldest records first) or DESC
for descending order (reverse-chronological, with the newest records first). This value corresponds to the ascending_order
query parameter used in the request.
List of Chat Events for the specified page_number
and page_size
.
The page number of the returned list.
This value corresponds to the page_number
parameter specified in the request. Pagination uses zero-based indexing.
The maximum number of items returned per page.
This value corresponds to the page_size
parameter specified in the request.