curl --request GET \
  --url https://api.periskope.app/v1/chats/notifications \
  --header 'Authorization: Bearer <token>'
{
  "from": 1,
  "to": 10,
  "count": 10,
  "messages": [
    "<any>"
  ]
}

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

Example:

"{{orgPhone}}"

Query Parameters

​
offset
number
  • The offset value for paginating the results
  • Default 0
Example:

"0"

​
limit
number
  • The maximum number of notifications to retrieve
  • Default 2000
Example:

"10"

Response

200
application/json
​
from
number

The starting index of the returned notifications.

Example:

1

​
to
number

The ending index of the returned notifications.

Example:

10

​
count
number

The total count of notifications.

Example:

10

​
messages
any[]

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

Was this page helpful?

List All MessagesUpdate Chat Labels