Skip to main content
Node.js
import { PeriskopeApi } from '@periskope/periskope-client';

const client = new PeriskopeApi({
  authToken: 'YOUR_API_KEY',
  phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});

async function fetchReactions() {
  const response = await client.reaction.getReactions();

  console.log(response);
}

fetchReactions();
{
  "from": 1,
  "start_time": "2025-08-15T00:00:00Z",
  "end_time": "2025-08-15T23:59:59Z",
  "to": 2,
  "count": 2,
  "reactions": [
    {
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "message_id": "[email protected]_3D023C13C1487916ED112C671C348635",
      "ack": null,
      "id": {
        "id": "12F4BBF6D901439A78B5B404A4662308",
        "remote": "[email protected]",
        "from_me": false,
        "serialized": "[email protected]_12F4BBF6D901439A78B5B404A4662308"
      },
      "orphan": null,
      "reaction": "😢",
      "read": true,
      "reaction_id": "[email protected]_12F4BBF6D901439A78B5B404A4662308",
      "timestamp": "2025-07-14T03:07:00.003+00:00",
      "msg_id": {
        "id": "3D023C13C1487916ED112C671C348635",
        "remote": "[email protected]",
        "from_me": false,
        "serialized": "[email protected]_3D023C13C1487916ED112C671C348635"
      },
      "orphan_reason": null,
      "sender_id": "[email protected]",
      "org_phone": "[email protected]",
      "chat_id": "[email protected]",
      "unique_id": "3D023C13C1487916ED112C671C348635"
    },
    {
      "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5",
      "message_id": "[email protected]_3A6A3C183F00093184DB",
      "ack": null,
      "id": {
        "id": "3EB0B1654FCA55F479F316",
        "remote": "[email protected]",
        "from_me": false,
        "serialized": "[email protected]_3EB0B1654FCA55F479F316"
      },
      "orphan": null,
      "reaction": "👍",
      "read": true,
      "reaction_id": "[email protected]_3EB0B1654FCA55F479F316",
      "timestamp": "2025-08-16T13:58:47.252+00:00",
      "msg_id": {
        "id": "3A6A3C183F00093184DB",
        "remote": "[email protected]",
        "from_me": false,
        "serialized": "[email protected]_3A6A3C183F00093184DB"
      },
      "orphan_reason": null,
      "sender_id": "[email protected]",
      "org_phone": "[email protected]",
      "chat_id": "[email protected]",
      "unique_id": "3A6A3C183F00093184DB"
    }
  ]
}

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

​
chat_id
string

Use this option to fetch reactions of a specific chat.

  • For groups, enter the chat_id of the group. This will be a string that ends with @g.us
  • For 1-1 chats, enter the country_code + number of the recipient e.g. [email protected] (The @c.us is optional)
Example:

"[email protected]"

​
message_id
string

Use this option to fetch reactions of a specific message.

  • The message_id is a unique ID of a WA message on Periskope
Example:

"[email protected]_3D023C13C1487916ED112C671C348635"

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

"0"

​
limit
number
  • The maximum number of reactions to retrieve
  • Default 500
Example:

"10"

​
start_time
string
  • Filter for all reactions from the start_time timestamp onwards
Example:

"2025-04-25 or 2025-04-25T00:00:00Z"

​
end_time
string
  • Filter for all reactions up to the end_time timestamp
Example:

"2025-04-31 or 2025-04-31T23:59:59Z"

Response

200 - application/json

Reaction

​
from
number

The starting index of the reactions returned

Example:

1

​
to
number

The ending index of the reactions returned

Example:

10

​
start_time
string

The start_time of the reactions returned. The format should be YYYY-MM-DDTHH:MM:SSZ

Example:

"2025-08-15T00:00:00Z"

​
end_time
string

The end_time of the reactions returned. The format should be YYYY-MM-DDTHH:MM:SSZ

Example:

"2025-08-15T23:59:59Z"

​
count
number

The total number of reactions returned

Example:

10

​
reactions
array

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