This endpoint retrieves a specific ticket along with the associated chat, and messages


Get Ticket By ID

bearerAuth

The response is a ticket object, which also includes the chat and message details. Refer to [the ticket object here](/api-reference/objects/the-ticket-info-object)

Periskope Docs

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

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

WhatsApp Analytics

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 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

Automation rules is a powerful feature in Periskope that allow you to automate your monitoring and alerting workflows. You can create rules that trigger actions based on specific conditions.

What are Automation Rules?

Components of Automation Rules

Triggers

Conditions

Actions

Guide to set up automation rules in Periskope

Setting up Automation Rules

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 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

Automate your WhatsApp with Periskope APIs

How to authenticate your requests to Periskope

Authorization

This endpoint retrieves a specific chat from its chat_id


Get Chat By ID

This endpoint retrieves a paginated list of all messages for the specific chat_id (in descending order of timestamp)


Get Messages in a Chat

This endpoint retrieves a paginated list of all notifications for the specific chat_id (in descending order of timestamp)


Get Notifications in a Chat

This endpoint retrieves a paginated list of chats


List All Chats

This endpoint retrieves a paginated list of all messages across chats (in descending order of timestamp)


List All Messages

This endpoint retrieves a paginated list of all notifications across chats (in descending order of timestamp)


List All Notifications

This endpoint updates the labels for specific chats


Update Chat Labels

This endpoint updates properties of a chat


Update Chat

This endpoint creates a new group.
 - Note that creating a new 1-1 chat does not require any explicit API. Sending a message will automatically create the chat

Create Group

This endpoint adds a participant to a group

_Note that adding unknown numbers is a spammy action and can result in a ban_

_Per Meta's policies, a user will be added to a group directly only if they have enabled it in their privacy settings, and they are a member of your phone contacts_

_For all other cases, this will send an invite to them to join the group_


Add Participant to Group

This endpoint removes a participant from a group


Remove Participant from Group

This endpoint promotes a participant in a group to admin


Promote Participant to Admin

This endpoint demotes a participant in a group to member


Demote Participant to Member

This endpoint updates the settings of the group


Update Group Settings

This endpoint is used to send bulk messages to many chats


Broadcast Message

This endpoint deletes a message based on the `message_id` or `queue_id` to be deleted


Delete Message

This endpoint edits a message based on the `message_id` or `queue_id`


Edit Message

This endpoint forwards a message to other chats


Forward Message

This endpoint retrieves a specific message based on the `message_id` or `queue_id`


Get Message

This endpoint reacts to a message based on the `message_id` or `queue_id`


React to Message

This endpoint is used to send a message to a chat


Send Message

This endpoint retrieves a specific contact along with all associated `chat_ids` (1-1 chats and common groups).


Get Contact By ID

This endpoint retrieves a paginated list of contacts


Get Contacts

This endpoint updates the labels for specific contacts


Update Contact Labels

This endpoint updates properties of a contact


Update Contact

This endpoint retrieves a paginated list of tickets


Get Tickets

This endpoint updates properties of a ticket


Update Ticket

This endpoint returns the jobs currently in the queue


Fetch Queue Jobs

This endpoint returns the current status of the message queue

Get Queue Status

This endpoint purges the jobs in the queue

#### Request Params

- `queue_id` _(string, optional)_
    
    - Provide the queue_id of the message to purge only that job
        
- `broadcast_id` _(string, optional)_
    
    - Provide the broadcast_id to purge all messages of that broadcast
        

If no params are provided, this will purge all the message jobs in the queue

Purge Queue

This endpoint retrieves information about the phone (specified in the x-phone header)

Get phone

This endpoint retrieves the QR code of the phone (specified in the x-phone header).

- Note: QR code will only be available when the phone is in a DISCONNECTED state
    
- If the QR is not available, you can reset the phone to generate a fresh QR

Get QR

This endpoint will logout the session and reset the phone connection to the QR state.

**Note: You will need to rescan the QR code to establish the connection**

Reset Phone

This endpoint restarts the phone connection

Restart Phone

This endpoint is triggers a resynchronization of all data between the phone and WhatsApp

Resync Phone

This endpoint updates properties of the phone


Update 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 `message.flagged` webhook is triggered when a message is flagged on Periskope.

message.flagged

The `message.unflagged` webhook is triggered when a message is unflagged on Periskope.

message.unflagged

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

APIs & Webhooks

Free Tools

Docs

Dashboard

Postman API collection

Support

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

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

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 received on WhatsApp.

The Message Object

The Contact object represents a contact in WhatsApp.

The Contact Object

The Ticket Info Object represents a ticket on Periskope.

The Ticket Object

The Phone object represents an organisation phone on Periskope.

API

Chat APIs

Group Settings APIs

Message APIs

Contact APIs

Ticket APIs

Queue APIs

Phone APIs

Webhooks

Get Ticket By ID

Authorizations

Path Parameters

Response