> ## Documentation Index
> Fetch the complete documentation index at: https://docs.periskope.app/llms.txt
> Use this file to discover all available pages before exploring further.
# Get Queue Status
> This endpoint returns the current status of the message queue
**Deprecated.** Use [`GET /message/queues/health`](/api-reference/message/queue-health) instead
## OpenAPI
````yaml GET /queue
openapi: 3.0.3
info:
title: API - Local
description: >-
#### Welcome to the official Postman collection of Periskope API
Periskope APIs enable you automate actions on your WhatsApp phone, and the
Periskope platform
- Read more about the APIs & webhooks here -
[https://docs.periskope.app/api-reference/introduction](https://docs.periskope.app/api-reference/introduction)
- We encourage responsible usage of the APIs. Follow these best practices
and recommendations for safe actions on WhatsApp -
[https://docs.periskope.app/get-started/best-practices](https://docs.periskope.app/get-started/best-practices)
#### Getting Started
##### Pre-requisites:
1. **Sign up for a free account on Periskope:** To use the Periskope API,
you need to have an active Periskope account. If you don’t have one, you can
sign up for a 7-day free trial [here](https://console.periskope.app).
2. **Scan the QR code from WhatsApp to connect your phone:** A connected
phone is required to use the APIs
3. **Go to** [Settings >
API](https://console.periskope.app/settings/api), and generate an API key
for your organization - The API key is used to authenticate every request.
Please keep this secure
##### Using Postman:
1. **Fork the collection so you can edit values and test the APIs in your
own postman environment:** To fork the collection, click on the three dots
next to v1. Then click on create a fork (_shortcut: Ctrl + Alt + F)._
2. **Update the value of the variables in the collection:**
\- Update the API key with the key generated in Step 3
\- Update the phone number with your connected number. This number will be added to the `x-phone` header across requests
It must be in the format of country code+number, with no special characters or spaces _e.g. +91 98745 32456 becomes 919874532456_
For any help or feedback, please contact us at
[support@periskope.app](https://mailto:support@periskope.app), or ping us on
[WhatsApp](https://what.sapp.link/periskope)
version: 1.0.0
contact: {}
servers:
- url: https://api.periskope.app/v1
security:
- bearerAuth: []
tags:
- name: contacts
- name: tickets
- name: tasks
- name: phones
- name: message
- name: queue
- name: chats
- name: group
- name: members
- name: webhooks
- name: custom properties
paths:
/queue:
get:
tags:
- queue
summary: Get Queue Status
description: This endpoint returns the current status of the message queue
operationId: getQueueStatus
parameters:
- name: x-phone
in: header
schema:
type: string
example: '{{orgPhone}}'
description: >-
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
responses:
'200':
description: 200 OK
headers:
Access-Control-Allow-Origin:
schema:
type: string
example: '*'
Connection:
schema:
type: string
example: keep-alive
Content-Length:
schema:
type: string
example: '69'
Date:
schema:
type: string
example: Wed, 22 Jan 2025 06:12:36 GMT
ETag:
schema:
type: string
example: W/"45-39UxucuQUTFAilfIoynIPHnZ9ao"
Keep-Alive:
schema:
type: string
example: timeout=5
X-Powered-By:
schema:
type: string
example: Express
X-RateLimit-Limit:
schema:
type: string
example: '10'
X-RateLimit-Remaining:
schema:
type: string
example: '9'
X-RateLimit-Reset:
schema:
type: string
example: '1737526358'
x-periskope-org-id:
schema:
type: string
example: 2997dd64-89bf-48d3-9a22-b314fca017e5
x-periskope-phone-id:
schema:
type: string
example: phone-bqzvyibhmwkaergr
x-periskope-trace-id:
schema:
type: string
example: e02684a0-d887-11ef-9390-15ae9381a2cb
content:
application/json:
schema:
type: object
description: >-
The response is a JSON object with details about the queue
running status and a summary count of the job status in the
last 24 hours
- `is_running`
- If this is true, the queue is running.
- Reverts to false when the phone connection is DISCONNECTED
- `active`
- The number of jobs currently being processed by the queue
- `completed`
- The number of jobs completed successfully in the last 24 hours
- `failed`
- The number of jobs that failed in the last 24 hours
- `pending`
- The number of jobs currently waiting in the queue
examples:
200 OK:
value:
active: 0
completed: 16
failed: 10
is_running: true
pending: 0
x-codeSamples:
- lang: TypeScript
label: Node.js
source: |-
import { PeriskopeApi } from '@periskope/periskope-client';
const client = new PeriskopeApi({
authToken: 'YOUR_API_KEY',
phone: 'YOUR_PHONE_NUMBER', // e.g., '919876543210'
});
async function getQueueStatus() {
const response = await client.queue.getStatus();
console.log(response);
}
getQueueStatus();
- lang: cURL
label: cURL
source: |
curl -X GET \
https://api.periskope.app/v1/queue \
-H 'Authorization: Bearer ' \
-H 'Content-Type: application/json' \
-H 'x-phone: YOUR_PHONE_NUMBER' \
components:
securitySchemes:
bearerAuth:
type: http
scheme: bearer
````