Sign in

v1

latestOpenAPI 3.0.32026-07-26870417.2 KB
reaction

Fetch Reactions

This endpoint is used to fetch reactions for an org or a specific chat or message.

You can use chat_id and message_id to filter reactions specific to a chat or message.

Response

The response is an array of JSON reaction objects. Refer to the reaction object here

get/reactions

Query parameters

chat_idstring

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. 919537851844@c.us (The @c.us is optional)
Example:9184090XXXXX@c.us
message_idstring

Use this option to fetch reactions of a specific message.

  • The message_id is a unique ID of a WA message on Periskope
Example:true_9184090XXXXX@c.us_3D023C13C1487916ED112C671C348635
offsetnumber
  • The offset value for paginating the results
  • Default 0
limitnumber
  • The maximum number of reactions to retrieve
  • Default 500
start_timestring
  • Filter for all reactions from the start_time timestamp onwards
Example:2025-04-25 or 2025-04-25T00:00:00Z
end_timestring
  • Filter for all reactions up to the end_time timestamp
Example:2025-04-31 or 2025-04-31T23:59:59Z

Headers

x-phonestring
Example:{{orgPhone}}

Optional. The phone to scope this request to — in country code + number format with no spaces or special characters (e.g. 919876543210), or the phone_id (phone-xxxxxxxxxxxx). When set, only reactions for that phone are returned. When omitted, reactions are returned — across all phones your token can access (the phones in your token's scope, or every phone in your organization if the token is unscoped). Passing a phone that is outside your token's scope returns a 401.

Response

Reaction

fromnumber

The starting index of the reactions returned

tonumber

The ending index of the reactions returned

start_timestring

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

end_timestring

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

countnumber

The total number of reactions returned

Example response

{
  "from": 1,
  "to": 10,
  "start_time": "2025-08-15T00:00:00Z",
  "end_time": "2025-08-15T23:59:59Z",
  "count": 10
}