List chat_groups | Hume API

Fetches a paginated list of Chat Groups.

Authentication

X-Hume-Api-Keystring

API Key authentication via header

Query parameters

page_numberintegerOptionalDefaults to 0

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 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.

page_sizeintegerOptional

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.

ascending_orderbooleanOptional

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.

config_idstringOptionalformat: "uuid"

The unique identifier for an EVI configuration.

Filter Chat Groups to only include Chats that used this config_id in their most recent Chat.

Response

Success

chat_groups_pagelist of objects

List of Chat Groups and their metadata returned for the specified page_number and page_size.

first_start_timestamplong

Time at which the first Chat in this Chat Group was created. Measured in seconds since the Unix epoch.

idstring

Identifier for the Chat Group. Any Chat resumed from this Chat Group will have the same chat_group_id. Formatted as a UUID.

most_recent_start_timestamplong

Time at which the most recent Chat in this Chat Group was created. Measured in seconds since the Unix epoch.

num_chatsinteger

The total number of Chats associated with this Chat Group.

activebooleanOptional

most_recent_chat_idstring or nullOptional

The chat_id of the most recent Chat in this Chat Group. Formatted as a UUID.

most_recent_configobjectOptional

The Config associated with this Chat.

page_numberinteger

The page number of the returned list.

This value corresponds to the page_number parameter specified in the request. Pagination uses zero-based indexing.

page_sizeinteger

The maximum number of items returned per page.

This value corresponds to the page_size parameter specified in the request.

pagination_directionenum

Allowed values:

total_pagesinteger

The total number of pages in the collection.