Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-phone
string

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

Path Parameters

chat_id
string
required
  • The unique id of the chat
  • For individual chats, this would be the country_code + number (e.g., 918527184400). Optionally, you can add @c.us
  • For groups, this would end with @g.us

Query Parameters

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

Response

200 - application/json
count
number

The total count of messages.

from
number

The starting index of the returned notifications.

notifications
any[]

An array of notification objects. Refer to the notification object here

to
number

The ending index of the returned messages.