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

Query Parameters

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

Response

200 - application/json

The response is a JSON object with the following properties:

count
number

The total count of messages.

from
number

The starting index of the returned messages.

messages
any[]

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

to
number

The ending index of the returned messages.