Chat with us

Blog

API Collection

Periskope Docs

Docs

APIs & Webhooks

Dashboard

Postman API collection

Support

The Phone object represents an organisation phone on Periskope.

The Phone Object

Your guide to get up and running with Periskope WhatsApp platform

Introduction

Guide to setting up your organization account on Periskope

Setting up your account

Guide to connecting your WhatsApp numbers to Periskope

Connect WhatsApp to Periskope

Most common use cases for Periskope across industries, verticals and geographies

Common Use Cases

Essential best practices and recommendations for safe WhatsApp outreach

WhatsApp Outreach – Best Practices

Connect and manage multiple WhatsApp numbers from a single dashboard

Multi-number inbox

Give multiple users access to manage, view and respond to messages without being on WhatsApp

Multi-agent access

Walkthrough of the layout and features of the Chats screen

View & Manage Chats

Guide to schedule and send bulk messages to multiple WhatsApp groups & 1:1 chats with custom text, video, images

Sending a Bulk Message

Guide to personalise bulk messages with variables

Variables in Bulk Messages

Guide to creating templates for recurring use for bulk-messaging

Creating Message Templates

Guide to view bulk message logs, and stop and restart ongoing bulk messages

Bulk Message Logs

Guide to view and understand WhatsApp usage metrics via the Periskope dashboard

WhatsApp Analytics

Intuitively organize chats, contacts and tickets with custom labels

Organize chats with labels

Intuitively organize groups & chats with custom properties

Organize chats with custom properties

Setup quick replies for frequent queries from customers

Setup Quick Replies

Guide to easily add, remove, promote, demote members across mutlitple WhatsApp groups

Bulk WhatsApp Actions

Export chat data, group members, contact attributes and files

Manage & Export Data

Walkthrough of the layout and features of the Contacts screen

View & Manage Contacts

Store frequently used media and docs on Periskope for ease of access.

Media Library

Guide to create and manage tickets/tasks on WhatsApp groups and 1:1 chats

Create a ticket from any WhatsApp message

Guide to creating tickets directly from WhatsApp groups with an emoji

Create a ticket with an emoji

Guide to automatically flag important messages with Periskope AI

Flag important messages with AI

Export Tickets

Guide to inviting your team, and provide role-based access to groups

Invite Team

Guide to giving restricted access to teams to view and reply on WhatsApp via Periskope

Manage Team Access

Walkthrough of the layout and features of the Chat-List screen

Chat List

Walkthrough of the layout of the settings screens

Settings

Guide to connect your HubSpot account with Periskope

HubSpot

Guide to setup zapier triggers on Periskope

Zapier

Guide to setup Freshdesk Integration on Periskope

Freshdesk

Guide to setup Zohodesk Integration on Periskope

Zohodesk

Google Sheets

Guide to setup Authentication on Periskope

Create a Chat

Get information about a chat by providing the chat ID. 

 Refer to the [Chat](https://docs.periskope.app/api-reference/objects/the-chat-object) object to find more details about the `chat object`.

Retrieve a Chat

Lists all chats on your phone. 

Refer to the [Chat](https://docs.periskope.app/api-reference/objects/the-chat-object) object to find more details about the `chat object`.

List all Chats

List all the chat messages associated with the chat_id. 

 Refer to the [Message](https://docs.periskope.app/api-reference/objects/the-message-object) object to find more details about the `message object`.

List all chat messages by Chat ID

Lists all chat labels. Useful for when you want to find the label IDs or active labels on all chats in your org.  

 Refer to the [Labels](https://docs.periskope.app/api-reference/objects/the-label-object) object to find more details about the `label object`.

List all org labels (Chat)

To update labels for multiple chats at once 

 Older versions of the API used `PATCH /chats/labels` as the endpoint. This is now deprecated and replaced with `PATCH /chats/labels/update`

Update chat labels by Chat IDs

Lists all the custom properties added to chats in your org. Useful for getting the custom property ids and their values for each chat. 

 Refer to the [Custom Property](https://docs.periskope.app/api-reference/objects/the-custom-property-object) object to find more details about the `custom property object`.

List all org custom properties (Chat)

To update custom properties for multiple chats at once

 Older versions of the API used `PATCH /chats/update_properties` as the endpoint. This is now deprecated and replaced with `PATCH /chats/custom-properties/update`

Update chat custom properties by Chat IDs

Add participants to a group. This operation requires the connected phone to be an admin in the group.

**Participants will only be added if they have allowed addition to groups. If they can't be added automatically, they will receive an invite to join the group**

Add member to group

Remove participants from a group. This operation requires the connected phone to be an admin in the group.

**Participants will only be removed if they are NOT the owner of the group.**

Remove member from group

Promote participants in a group. This operation requires the connected phone to be an admin in the group.



Promote member in group to admin

Demote participants in a group. This operation requires the connected phone to be an admin in the group.



Demote admin in group to member

Update group settings e.g. member permissions, group image, title or description. This operation requires the connected phone to be an admin in the group.



Change group settings

Send a text or media message to a chat

The chat_id for an individual chat is of the following format: (country_code + phone_number + @c.us). e.g. The chat_id for +91 90043 89567 is 919004389372@c.us

For a group chat, you need to fetch the chat_id (it will end in @g.us). You can fetch this in the settings sidepanel on Periskope (or by right-clicking on any chat and copying the id)

 Returns `sent_message_id` for the message. This can be used to get message status using [Get Message By ID](https://docs.periskope.app/api-reference/message/get-message) API

Send a message

Broadcasts a message to multiple chats

Any of - `chat_ids` | `label` can be used to send a broadcast message.

The broadcast will be sent using the phone number provided in the request. If no phone number is provided, the broadcast will be sent using the connected phone number.

Broadcast a message

Get message status by message_id. 

 Refer to the [Message](https://docs.periskope.app/api-reference/objects/the-message-object) object to find more details about the `message object`. 

 Any of - `message_id` | `sent_message_id` | `unique_id` can be used for getting the message. 

1. When getting a ticket info, `quoted_message_id` in ticket object is the `unique_id` of the message.

2. When sending a message, `sent_message_id` is returned in the response. 

 3. When listing a chat messages, `message_id` is returned in the response object.

Get message

Edit a message. 

 Editing message body is only possible for a short duration after the message is sent

Edit a message

Forward a message to chat_ids. 

 Forwarding is limited by WA to a select set of chats. If you would like to send to more chats, use broadcasts

Forward a message

Delete a message. 

 Message deletion is only allowed for upto 48 hours of sending the message (and if you have the required permissions)

Delete a message

React to a message. 

 Reaction should be sent as a supported emoji. To delete a reaction, send a blank string instead

React to a message

Gets all the contacts in your organization

Get all contacts

Update contact details like name and internal status

Update contact

Updates lables associated with contacts. 

**This `API` replaces all the current labels on provided Contact IDs with the new labels**

Update contacts labels

Get ticket information by ticket ID. 

 Refer to the [Ticket info](https://docs.periskope.app/api-reference/objects/the-ticket-info-object) object to find more details about the `ticket info object`.

Get ticket info

List all ticket labels. Useful for findind label IDs and filtering tickets based on labels.

 Refer to the [Label object](https://docs.periskope.app/api-reference/objects/the-label-object) object to find more details about the `label object`.

List all org labels (ticket)

Get message queue

Purges your message queue. Useful for when you want to stop all queued messages from being sent.

Purge message queue

Get phone info 

 Refer to the [Phone object](https://docs.periskope.app/api-reference/objects/the-phone-object) object to find more details about the `phone object`.

Get phone

Update phone

Restarts your phone's instance. Useful in case of any issues with the phone

Restart phone

Resync phone

The `chat.created` webhook is triggered when a new group or individual chat is created on whatsapp.

chat.created

The `chat.notification.created` webhook is triggered when any action is performed on a chat. For e.g. when a member is added or removed from a chat, when group settings is updated.

chat.notification.created

The `message.created` webhook is triggered when a new message is received or sent on whatsapp.

message.created

The `message.updated` webhook is triggered when a message is edited on whatsapp.

message.updated

The `message.deleted` webhook is triggered when a message is deleted on whatsapp.

message.deleted

The `message.ack.updated` webhook is triggered when a new message is received or sent on whatsapp.

message.ack.updated

The `reaction.created` webhook is triggered when a reaction is created on Whatsapp.

reaction.created

The `reaction.updated` webhook is triggered when a reaction is updated on Periskope.

reaction.updated

The `ticket.created` webhook is triggered when a new ticket is created on Periskope.

ticket.created

The `ticket.updated` webhook is triggered when ticket details are updated on Periskope.

ticket.updated

The `ticket.deleted` webhook is triggered when a ticket is deleted on Periskope.

ticket.deleted

The Chat object represents a chat in WhatsApp.

The Chat Object

The Chat Notification object represents a chat update notification in WhatsApp.

The Chat Notification Object

The Reaction object represents a message reaction in WhatsApp.

The Reaction Object

The message object represents a message sent or receive on WhatsApp.

The Message Object

The custom property object represents a custom property for a chat on Periskope.

API

Webhooks

Objects