Chat APIs
Get Notifications in a Chat
API
- Introduction
- Authorization
- Objects
Chat APIs
Group Settings APIs
Message APIs
Chat APIs
Get Notifications in a Chat
This endpoint retrieves a paginated list of all notifications for the specific chat_id (in descending order of timestamp)
curl --request GET \
--url https://api.periskope.app/v1/chats/{chat_id}/notifications \
--header 'Authorization: Bearer <token>'
{
"count": 5,
"from": 1,
"messages": [
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "fa3c48a78cc64e139e5737f7057235ea",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_fa3c48a78cc64e139e5737f7057235ea_918527184400@c.us_remove"
},
"notification_id": "true_120363371308389685@g.us_fa3c48a78cc64e139e5737f7057235ea_918527184400@c.us_remove",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": [
"919537851844@c.us"
],
"timestamp": "2025-01-11T11:52:27.231+00:00",
"type": "remove",
"unique_id": "fa3c48a78cc64e139e5737f7057235ea"
},
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "fd73a0384afe4bc89991c3303cacab4b",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_fd73a0384afe4bc89991c3303cacab4b_918527184400@c.us_remove"
},
"notification_id": "true_120363371308389685@g.us_fd73a0384afe4bc89991c3303cacab4b_918527184400@c.us_remove",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": [
"919535999383@c.us"
],
"timestamp": "2025-01-11T11:52:27.127+00:00",
"type": "remove",
"unique_id": "fd73a0384afe4bc89991c3303cacab4b"
},
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "05f652baf6e54522b855d70ad43b813c",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_05f652baf6e54522b855d70ad43b813c_918527184400@c.us_add"
},
"notification_id": "true_120363371308389685@g.us_05f652baf6e54522b855d70ad43b813c_918527184400@c.us_add",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": [
"919537851844@c.us"
],
"timestamp": "2025-01-11T11:52:16.859+00:00",
"type": "add",
"unique_id": "05f652baf6e54522b855d70ad43b813c"
},
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "686bd17a4c3b4d7e9e84e5fe884de8bc",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_686bd17a4c3b4d7e9e84e5fe884de8bc_918527184400@c.us_memberaddmode_false"
},
"notification_id": "true_120363371308389685@g.us_686bd17a4c3b4d7e9e84e5fe884de8bc_918527184400@c.us_memberaddmode_false",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": null,
"timestamp": "2025-01-11T11:51:59.974+00:00",
"type": "memberaddmode_false",
"unique_id": "686bd17a4c3b4d7e9e84e5fe884de8bc"
},
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "8c04cef4f58148ae91fc2654260bae55",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_8c04cef4f58148ae91fc2654260bae55_918527184400@c.us_memberaddmode_true"
},
"notification_id": "true_120363371308389685@g.us_8c04cef4f58148ae91fc2654260bae55_918527184400@c.us_memberaddmode_true",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": null,
"timestamp": "2025-01-11T11:51:51.177+00:00",
"type": "memberaddmode_true",
"unique_id": "8c04cef4f58148ae91fc2654260bae55"
}
],
"to": 5
}
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
Example:
"{{orgPhone}}"
Path Parameters
- 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
Example:
"120363371308389685@g.us"
Query Parameters
- The offset value for paginating the results
- Default 0
Example:
"0"
- The maximum number of notifications to retrieve
- Default 2000
Example:
"10"
Response
200
application/json
200 OK
The starting index of the returned notifications.
Example:
1
The ending index of the returned messages.
Example:
10
The total count of messages.
Example:
10
An array of notification objects. Refer to the notification object here
Was this page helpful?
curl --request GET \
--url https://api.periskope.app/v1/chats/{chat_id}/notifications \
--header 'Authorization: Bearer <token>'
{
"count": 5,
"from": 1,
"messages": [
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "fa3c48a78cc64e139e5737f7057235ea",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_fa3c48a78cc64e139e5737f7057235ea_918527184400@c.us_remove"
},
"notification_id": "true_120363371308389685@g.us_fa3c48a78cc64e139e5737f7057235ea_918527184400@c.us_remove",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": [
"919537851844@c.us"
],
"timestamp": "2025-01-11T11:52:27.231+00:00",
"type": "remove",
"unique_id": "fa3c48a78cc64e139e5737f7057235ea"
},
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "fd73a0384afe4bc89991c3303cacab4b",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_fd73a0384afe4bc89991c3303cacab4b_918527184400@c.us_remove"
},
"notification_id": "true_120363371308389685@g.us_fd73a0384afe4bc89991c3303cacab4b_918527184400@c.us_remove",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": [
"919535999383@c.us"
],
"timestamp": "2025-01-11T11:52:27.127+00:00",
"type": "remove",
"unique_id": "fd73a0384afe4bc89991c3303cacab4b"
},
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "05f652baf6e54522b855d70ad43b813c",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_05f652baf6e54522b855d70ad43b813c_918527184400@c.us_add"
},
"notification_id": "true_120363371308389685@g.us_05f652baf6e54522b855d70ad43b813c_918527184400@c.us_add",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": [
"919537851844@c.us"
],
"timestamp": "2025-01-11T11:52:16.859+00:00",
"type": "add",
"unique_id": "05f652baf6e54522b855d70ad43b813c"
},
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "686bd17a4c3b4d7e9e84e5fe884de8bc",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_686bd17a4c3b4d7e9e84e5fe884de8bc_918527184400@c.us_memberaddmode_false"
},
"notification_id": "true_120363371308389685@g.us_686bd17a4c3b4d7e9e84e5fe884de8bc_918527184400@c.us_memberaddmode_false",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": null,
"timestamp": "2025-01-11T11:51:59.974+00:00",
"type": "memberaddmode_false",
"unique_id": "686bd17a4c3b4d7e9e84e5fe884de8bc"
},
{
"author": "918527184400@c.us",
"body": null,
"chat_id": "120363371308389685@g.us",
"id": {
"fromMe": true,
"id": "8c04cef4f58148ae91fc2654260bae55",
"remote": "120363371308389685@g.us",
"serialized": "true_120363371308389685@g.us_8c04cef4f58148ae91fc2654260bae55_918527184400@c.us_memberaddmode_true"
},
"notification_id": "true_120363371308389685@g.us_8c04cef4f58148ae91fc2654260bae55_918527184400@c.us_memberaddmode_true",
"org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
"org_phone": "918527184400@c.us",
"recipientids": null,
"timestamp": "2025-01-11T11:51:51.177+00:00",
"type": "memberaddmode_true",
"unique_id": "8c04cef4f58148ae91fc2654260bae55"
}
],
"to": 5
}