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

# List All Message Queues

> Lists the jobs retained in the send queue of the phone. Pass broadcast_id to track a broadcast, or queue_id for a single job.



## OpenAPI

````yaml api-reference/openapi-generated.json POST /v1/message/queues
openapi: 3.0.3
info:
  title: Periskope API
  version: 1.0.0
  description: >-
    Periskope external API.


    Responses use a flat, unwrapped shape: most endpoints return the resource at
    the top level, and list endpoints return a wrapper object with pagination
    inline (e.g. `{ from, to, count, chats: [...] }`). The documented response
    schemas describe these shapes directly.
servers:
  - url: https://api.periskope.app
security:
  - bearerAuth: []
paths:
  /v1/message/queues:
    post:
      tags:
        - Messages
      summary: List message queue jobs
      description: >-
        Lists the jobs retained in the send queue of the phone. Pass
        broadcast_id to track a broadcast, or queue_id for a single job.
      operationId: createMessageQueue
      parameters:
        - schema:
            type: string
            minLength: 1
            example: '919876543210'
            description: >-
              Phone to act with: country code + number without symbols or spaces
              (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). The phone
              must be connected to the org and accessible by the API token.
          required: true
          description: >-
            Phone to act with: country code + number without symbols or spaces
            (e.g. 911111111111), or a phone_id (phone-xxxxxxxxxxxx). The phone
            must be connected to the org and accessible by the API token.
          name: x-phone
          in: header
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                queue_id:
                  type: string
                  description: Return only the job with this queue job id
                  example: 00000000-0000-0000-0000-000000000000
                broadcast_id:
                  type: string
                  description: Return only the jobs belonging to this broadcast
                  example: 00000000-0000-0000-0000-000000000000
      responses:
        '200':
          description: The matching queue jobs
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MessageQueueJob'
                description: The matching jobs currently retained in the send queue
              examples:
                default:
                  summary: Response body
                  value:
                    - queue_id: 00000000-0000-0000-0000-000000000000
                      unique_id: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
                      message_id: >-
                        true_911111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
                      chat_id: 911111111111@c.us
                      performed_by: api
                      status: delivered
                      status_description: Delivered to recipient.
                      message:
                        body: Hello World
                        type: chat
                        quoted_message_id: null
                      timeline:
                        queued_at: '2026-01-15T09:30:00.000Z'
                        sent_at: '2026-01-15T09:30:02.000Z'
                        failed_at: null
                        processing_started_at: null
                      attempts: 1
        '400':
          description: The phone is off or its server is unreachable
          content:
            application/json:
              examples:
                error:
                  summary: The phone is off or its server is unreachable
                  value:
                    code: ERROR
                    message: The phone is off or its server is unreachable
                    status: 400
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: ERROR
                  message:
                    type: string
                    example: The phone is off or its server is unreachable
                  status:
                    type: integer
                    example: 400
                example:
                  code: ERROR
                  message: The phone is off or its server is unreachable
                  status: 400
        '401':
          description: Invalid, expired or missing API token
          content:
            application/json:
              examples:
                error:
                  summary: Invalid, expired or missing API token
                  value:
                    code: UNAUTHORIZED_ERROR
                    message: Invalid bearer auth token
                    status: 401
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: UNAUTHORIZED_ERROR
                  message:
                    type: string
                    example: Invalid bearer auth token
                  status:
                    type: integer
                    example: 401
                example:
                  code: UNAUTHORIZED_ERROR
                  message: Invalid bearer auth token
                  status: 401
        '422':
          description: Request validation failed
          content:
            application/json:
              examples:
                error:
                  summary: Request validation failed
                  value:
                    code: VALIDATION_ERROR
                    message: Request validation failed
                    status: 422
                    fields:
                      body.chat_id:
                        message: chat_id is required
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: VALIDATION_ERROR
                  message:
                    type: string
                    example: Request validation failed
                  status:
                    type: integer
                    example: 422
                  fields:
                    type: object
                    additionalProperties:
                      type: object
                      properties:
                        message:
                          type: string
                        value: {}
                    example:
                      body.chat_id:
                        message: chat_id is required
                example:
                  code: VALIDATION_ERROR
                  message: Request validation failed
                  status: 422
                  fields:
                    body.chat_id:
                      message: chat_id is required
        '429':
          description: Rate limit exceeded
          content:
            application/json:
              examples:
                error:
                  summary: Rate limit exceeded
                  value:
                    code: RATE_LIMIT_ERROR
                    message: You can only make 100 requests per second
                    status: 429
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: RATE_LIMIT_ERROR
                  message:
                    type: string
                    example: You can only make 100 requests per second
                  status:
                    type: integer
                    example: 429
                example:
                  code: RATE_LIMIT_ERROR
                  message: You can only make 100 requests per second
                  status: 429
        '500':
          description: Internal server error
          content:
            application/json:
              examples:
                error:
                  summary: Internal server error
                  value:
                    code: UNKNOWN_ERROR
                    message: Internal server error
                    status: 500
              schema:
                type: object
                properties:
                  code:
                    type: string
                    example: UNKNOWN_ERROR
                  message:
                    type: string
                    example: Internal server error
                  status:
                    type: integer
                    example: 500
                example:
                  code: UNKNOWN_ERROR
                  message: Internal server error
                  status: 500
      security:
        - bearerAuth: []
      x-codeSamples:
        - lang: typescript
          label: TypeScript
          source: |-
            import { PeriskopeApi } from '@periskope/periskope-client';

            const client = new PeriskopeApi({
              authToken: 'YOUR_API_KEY',
              phone: '919876543210', // the phone to act with (x-phone)
            });

            async function main() {
              const response = await client.messages.createMessageQueue({
                queue_id: '00000000-0000-0000-0000-000000000000',
              });
              console.log(response);
            }

            main();
        - lang: bash
          label: cURL
          source: |-
            curl -X POST 'https://api.periskope.app/v1/message/queues' \
              -H 'Authorization: Bearer YOUR_API_KEY' \
              -H 'x-phone: 919876543210' \
              -H 'Content-Type: application/json' \
              -d '{
                "queue_id": "00000000-0000-0000-0000-000000000000"
              }'
components:
  schemas:
    MessageQueueJob:
      type: object
      properties:
        queue_id:
          type: string
          description: Id of the queue job
          example: 00000000-0000-0000-0000-000000000000
        unique_id:
          type: string
          description: >-
            unique_id of the queued message — the value returned by POST
            /message/send
          example: AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
        message_id:
          type: string
          description: >-
            WhatsApp message_id assigned once the message was submitted. null
            while the job has not completed.
          example: true_911111111111@c.us_AAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA
        chat_id:
          type: string
          description: Chat the message is being sent to
          example: 911111111111@c.us
        performed_by:
          type: string
          description: >-
            Who queued the message: a member's email, or 'api' when queued via
            the API
          example: api
        status:
          type: string
          description: >-
            Current state of the job: one of queued, scheduled, sending, sent,
            pending, delivered, read, played, failed. Queue states (queued,
            scheduled, sending, failed) come from the send queue; once the job
            completed, the state reflects the delivery acknowledgement (sent,
            delivered, read, played — or pending/failed).
          example: delivered
        status_description:
          type: string
          description: Human-readable explanation of the status
          example: Delivered to recipient.
        message:
          type: object
          properties:
            body:
              type: string
              description: Text content (or caption) of the queued message
              example: Hello World
            type:
              type: string
              description: Message type of the queued message (e.g. 'chat', 'image')
              example: chat
            quoted_message_id:
              type: string
              description: >-
                message_id being replied to. Present only when the queued
                message is a reply.
          description: The content of the queued message
        timeline:
          type: object
          properties:
            queued_at:
              type: string
              description: When the job was added to the queue (ISO 8601)
              example: '2026-01-15T09:30:00.000Z'
            sent_at:
              type: string
              description: >-
                When the job finished successfully (ISO 8601). Present only for
                completed jobs.
              example: '2026-01-15T09:30:02.000Z'
            failed_at:
              type: string
              description: When the job failed (ISO 8601). Present only for failed jobs.
            processing_started_at:
              type: string
              description: >-
                When the job started being processed (ISO 8601). Present only
                for jobs currently being submitted.
          description: Timestamps of the job lifecycle
        attempts:
          type: integer
          description: Number of submission attempts made so far
          example: 1
      description: >-
        A job in the message send queue of a phone. Every message sent via the
        API passes through this queue.
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: >-
        Your Periskope API token, sent as `Authorization: Bearer <token>`.
        Generate one from the Periskope dashboard under **Settings → API &
        Webhooks**. API access requires an active Pro or Enterprise plan.

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.