Fetches a ChatGroup by ID, including a paginated list of Chats associated with the ChatGroup.
Identifier for a Chat Group. Formatted as a UUID.
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.
Specifies the sorting order of the results based on their creation date. Set to true for ascending order (chronological, with the oldest records first) and false for descending order (reverse-chronological, with the newest records first). Defaults to true.
Success
Identifier for the Chat Group. Any Chat resumed from this Chat Group will have the same chat_group_id
. Formatted as a UUID.
Time at which the first Chat in this Chat Group was created. Measured in seconds since the Unix epoch.
Time at which the most recent Chat in this Chat Group was created. Measured in seconds since the Unix epoch.
The total number of Chats associated with this Chat Group.
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.
The total number of pages in the collection.
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 Chats for the specified page_number
and page_size
.
Denotes whether there is an active Chat associated with this Chat Group.