Chat APIs
List All Chats
This endpoint retrieves a paginated list of chats
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Headers
Please provide the number of the phone you want to call with this API in the header. The number must be in country code + number format without any characters or spaces, e.g. 919876543210; Alternatively, provide the phone_id (phone-xxxxxxxxxxxx) in the header
Query Parameters
- The offset value for paginating the results
- Default 0
- The maximum number of chats to retrieve
- Default 2000
- Filter chat by type of user, group or business
- Filter all chats that contain a specific label provide
- You can provide the name of the label or label_id
Response
200 - application/json
Note: members associated with a chat are not returned. You can fetch a specific chat by calling the Get Chat By ID endpoint
An array of chat objects. Refer to the chat object here
The total count of chats.
The starting index of the returned chats.
The ending index of the returned chats.
Was this page helpful?