List All Messages

import { PeriskopeApi } from '@periskope/periskope-client'; const client = new PeriskopeApi({ authToken: 'YOUR_API_KEY', phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210' }); async function getMessages() { const response = await client.chat.getMessages(); console.log(response); } getMessages();

{ "count": 10, "from": 1, "messages": [ { "ack": "4", "author": null, "body": "You have been invited to join Test New 1039\n\nhttps://chat.whatsapp.com/invite/CGiTdfn1dUM8J67GEx1lyx\n\nIf you cannot click the link, please respond to this message, and the link will become active", "broadcast": null, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered": { "919537851844@c.us": 1737695471721 }, "delivered_count": 1, "pending": [], "read": { "919537851844@c.us": 1737711828823 }, "read_count": 1 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": true, "fts": "'/invite/cgitdfn1dum8j67gex1lyx':12 '1039':9 'activ':29 'becom':28 'cannot':15 'chat.whatsapp.com':11 'chat.whatsapp.com/invite/cgitdfn1dum8j67gex1lyx':10 'click':16 'invit':4 'join':6 'link':18,26 'messag':23 'new':8 'pleas':19 'respond':20 'test':7", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": true, "id": "3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B", "remote": "919537851844@c.us", "serialized": "true_919537851844@c.us_3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "true_919537851844@c.us_3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "918527184400@c.us", "sent_message_id": "02a54379-36cc-456b-81c4-09074adf9597", "timestamp": "2025-01-24T05:11:08+00:00", "to": null, "token": null, "unique_id": "3EB0ABB7C973860FC19EBE05FD934141CCEC2D8B", "updated_at": "2025-01-24T09:43:48.884+00:00", "vcards": null }, { "ack": "0", "author": null, "body": "hello", "broadcast": false, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'hello':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "3FEBFB04480C6E256A37", "remote": "919537851844@c.us", "serialized": "false_919537851844@c.us_3FEBFB04480C6E256A37" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_919537851844@c.us_3FEBFB04480C6E256A37", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919537851844@c.us", "sent_message_id": null, "timestamp": "2025-01-23T12:05:29+00:00", "to": null, "token": null, "unique_id": "3FEBFB04480C6E256A37", "updated_at": "2025-01-23T12:05:30.038+00:00", "vcards": null }, { "ack": "0", "author": null, "body": "hello", "broadcast": false, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'hello':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "3F5E1F0061E439AABF93", "remote": "919537851844@c.us", "serialized": "false_919537851844@c.us_3F5E1F0061E439AABF93" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_919537851844@c.us_3F5E1F0061E439AABF93", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919537851844@c.us", "sent_message_id": null, "timestamp": "2025-01-23T12:04:57+00:00", "to": null, "token": null, "unique_id": "3F5E1F0061E439AABF93", "updated_at": "2025-01-23T12:04:58.332+00:00", "vcards": null }, { "ack": "0", "author": null, "body": "hello 4", "broadcast": false, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'4':2 'hello':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "3FB3DB0CD9143F36DA1B", "remote": "919537851844@c.us", "serialized": "false_919537851844@c.us_3FB3DB0CD9143F36DA1B" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_919537851844@c.us_3FB3DB0CD9143F36DA1B", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919537851844@c.us", "sent_message_id": null, "timestamp": "2025-01-23T11:24:08+00:00", "to": null, "token": null, "unique_id": "3FB3DB0CD9143F36DA1B", "updated_at": "2025-01-23T11:24:09.265+00:00", "vcards": null }, { "ack": "0", "author": null, "body": "hello 3", "broadcast": false, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'3':2 'hello':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "3FF19C7504579A580127", "remote": "919537851844@c.us", "serialized": "false_919537851844@c.us_3FF19C7504579A580127" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_919537851844@c.us_3FF19C7504579A580127", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919537851844@c.us", "sent_message_id": null, "timestamp": "2025-01-23T11:24:07+00:00", "to": null, "token": null, "unique_id": "3FF19C7504579A580127", "updated_at": "2025-01-23T11:24:07.941+00:00", "vcards": null }, { "ack": "0", "author": null, "body": "hello 2", "broadcast": false, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'2':2 'hello':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "3FBB9CD4D1AD736B47BA", "remote": "919537851844@c.us", "serialized": "false_919537851844@c.us_3FBB9CD4D1AD736B47BA" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_919537851844@c.us_3FBB9CD4D1AD736B47BA", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919537851844@c.us", "sent_message_id": null, "timestamp": "2025-01-23T11:24:02+00:00", "to": null, "token": null, "unique_id": "3FBB9CD4D1AD736B47BA", "updated_at": "2025-01-23T11:24:02.466+00:00", "vcards": null }, { "ack": "0", "author": null, "body": "hello 1", "broadcast": false, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": "'1':2 'hello':1", "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "3F7080525761DE5CE341", "remote": "919537851844@c.us", "serialized": "false_919537851844@c.us_3F7080525761DE5CE341" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": null, "media_key": null, "mentioned_ids": [], "message_id": "false_919537851844@c.us_3F7080525761DE5CE341", "message_ticket_id": null, "message_type": "chat", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919537851844@c.us", "sent_message_id": null, "timestamp": "2025-01-23T11:22:51+00:00", "to": null, "token": null, "unique_id": "3F7080525761DE5CE341", "updated_at": "2025-01-23T11:22:51.548+00:00", "vcards": null }, { "ack": "0", "author": null, "body": null, "broadcast": false, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": null, "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "17DEFC0BE5C1813C76E6267816452A02", "remote": "919537851844@c.us", "serialized": "false_919537851844@c.us_17DEFC0BE5C1813C76E6267816452A02" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": { "dimensions": { "ar": 0.3541666666666667, "height": 1200, "width": 425 }, "filename": "17DEFC0BE5C1813C76E6267816452A02", "mimetype": "image/jpeg", "path": "https://storage.googleapis.com/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us%2F17DEFC0BE5C1813C76E6267816452A02.jpeg", "size": 60511, "thumbnail": "https://storage.googleapis.com/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us%2F17DEFC0BE5C1813C76E6267816452A02%2Fthumbnail.png" }, "media_key": null, "mentioned_ids": [], "message_id": "false_919537851844@c.us_17DEFC0BE5C1813C76E6267816452A02", "message_ticket_id": null, "message_type": "image", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919537851844@c.us", "sent_message_id": null, "timestamp": "2025-01-23T11:17:00+00:00", "to": null, "token": null, "unique_id": "17DEFC0BE5C1813C76E6267816452A02", "updated_at": "2025-01-23T11:17:02.802+00:00", "vcards": null }, { "ack": "0", "author": null, "body": null, "broadcast": false, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": null, "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "6970084ECDA312DCA9D0C62A16697E31", "remote": "919537851844@c.us", "serialized": "false_919537851844@c.us_6970084ECDA312DCA9D0C62A16697E31" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": { "dimensions": { "ar": 0.53515625, "height": 1280, "width": 685 }, "filename": "6970084ECDA312DCA9D0C62A16697E31", "mimetype": "image/jpeg", "path": "https://storage.googleapis.com/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us%2F6970084ECDA312DCA9D0C62A16697E31.jpeg", "size": 68972, "thumbnail": "https://storage.googleapis.com/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us%2F6970084ECDA312DCA9D0C62A16697E31%2Fthumbnail.png" }, "media_key": null, "mentioned_ids": [], "message_id": "false_919537851844@c.us_6970084ECDA312DCA9D0C62A16697E31", "message_ticket_id": null, "message_type": "image", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919537851844@c.us", "sent_message_id": null, "timestamp": "2025-01-23T11:15:35+00:00", "to": null, "token": null, "unique_id": "6970084ECDA312DCA9D0C62A16697E31", "updated_at": "2025-01-23T11:15:36.298+00:00", "vcards": null }, { "ack": "0", "author": null, "body": null, "broadcast": false, "broadcast_id": null, "chat_id": "919537851844@c.us", "delivery_info": { "delivered_count": 0, "pending": [], "read_count": 0 }, "device_type": null, "duration": null, "flag_metadata": null, "flag_response_time": null, "flag_status": null, "forwarding_score": null, "from": null, "from_me": false, "fts": null, "has_media": null, "has_quoted_msg": null, "has_reaction": null, "id": { "from_me": false, "id": "018456CD73B9C9E4AF84836F809A02BF", "remote": "919537851844@c.us", "serialized": "false_919537851844@c.us_018456CD73B9C9E4AF84836F809A02BF" }, "invite_v4": null, "is_deleted": null, "is_ephemeral": null, "is_forwarded": null, "is_gif": null, "is_starred": null, "is_status": null, "links": null, "location": null, "media": { "dimensions": { "ar": 0.4545454545454546, "height": 1188, "width": 540 }, "filename": "018456CD73B9C9E4AF84836F809A02BF", "mimetype": "image/jpeg", "path": "https://storage.googleapis.com/periskope-attachments/2997dd64-89bf-48d3-9a22-b314fca017e5%2F919537851844%40c.us%2F018456CD73B9C9E4AF84836F809A02BF.jpeg", "size": 57218, "thumbnail": "https://storage.googleapis.com/periskope-attachments/%7Bclient.org_id%7D%2F919537851844%40c.us%2F018456CD73B9C9E4AF84836F809A02BF%2Fthumbnail.jpeg" }, "media_key": null, "mentioned_ids": [], "message_id": "false_919537851844@c.us_018456CD73B9C9E4AF84836F809A02BF", "message_ticket_id": null, "message_type": "image", "order_id": null, "org_id": "2997dd64-89bf-48d3-9a22-b314fca017e5", "org_phone": "918527184400@c.us", "performed_by": null, "poll_info": null, "poll_results": null, "prev_body": null, "quoted_message_id": null, "raw_data": null, "sender_phone": "919537851844@c.us", "sent_message_id": null, "timestamp": "2025-01-23T11:14:23+00:00", "to": null, "token": null, "unique_id": "018456CD73B9C9E4AF84836F809A02BF", "updated_at": "2025-01-23T11:14:24.598+00:00", "vcards": null } ], "to": 10 }

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 messages to retrieve
Default 2000

Example:

"10"

start_time

string

The start_time to filter the results

Example:

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

end_time

string

The end_time to filter the results

Example:

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

Response

200 OK

The response is a JSON object with the following properties:

from

number

The starting index of the returned messages.

Example:

1

number

The ending index of the returned messages.

Example:

10

count

number

The total count of messages.

Example:

10

messages

any[]

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

API

Chat APIs

Group Settings APIs

Message APIs

Contact APIs

Ticket APIs

Queue APIs

Phone APIs

Notes APIs

Reaction APIs

Webhooks

Authorizations

Headers

Query Parameters

Response