Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
chats

Get Notifications in a Chat

This endpoint retrieves a paginated list of all notifications for the specific chat_id (in descending order of timestamp)

get/chats/{chat_id}/notifications

Query parameters

offsetnumber
  • The offset value for paginating the results
  • Default 0
limitnumber
  • The maximum number of notifications to retrieve
  • Default 2000

Headers

x-phonestring
Example:{{orgPhone}}

Optional. The phone to scope this request to — in country code + number format with no spaces or special characters (e.g. 919876543210), or the phone_id (phone-xxxxxxxxxxxx). When set, only this chat's notifications for that phone are returned. When omitted, this chat's notifications are returned — across all phones your token can access (the phones in your token's scope, or every phone in your organization if the token is unscoped). Passing a phone that is outside your token's scope returns a 401.

Response

200 OK

fromnumber

The starting index of the returned notifications.

tonumber

The ending index of the returned messages.

countnumber

The total count of messages.

Example response

{
  "from": 1,
  "to": 10,
  "count": 10
}