> ## Documentation Index
> Fetch the complete documentation index at: https://developer.wabox.me/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Wabox é uma API não-oficial de WhatsApp (aparelho vinculado). Tudo é snake_case; a base é https://api.wabox.me/instances/{instance_id}/token/{token}.
> Envios respondem { id, message_id, wabox_id, status: "queued" } na hora; o resultado real chega no webhook delivery. Envios não são idempotentes: confira GET /queue antes de repetir.
> Sempre verifique X-Wabox-Signature (HMAC-SHA256 de "<t>.<corpo cru>") nos webhooks e deduplique por event_id.
> Botões, listas, carrossel e catálogo são best effort e não renderizam no WhatsApp Web/Desktop. Não existem: chamadas, listas de transmissão, histórico de mensagens, instância mobile.
> Não invente endpoints ou campos: use o OpenAPI em https://api.wabox.me/openapi.json.

# Listar mensagens na fila

> Mensagens enviadas pela API que ainda não saíram — normalmente porque a instância está desconectada (elas são entregues em ordem assim que reconectar). Paginado por `page`/`page_size` (máx. 100), do mais antigo para o mais novo. `wabox_id` é o id retornado no envio; `message_id` é o id que a mensagem terá no WhatsApp; `payload` é o conteúdo original.



## OpenAPI

````yaml /openapi.json get /instances/{instance_id}/token/{token}/queue
openapi: 3.1.0
info:
  title: Wabox API
  description: >-
    API pública do Wabox — WhatsApp via REST + webhooks.


    Base: `{server}/instances/{instance_id}/token/{token}`. Header
    `Client-Token` obrigatório quando ativado em Segurança.


    Tudo em `snake_case`. Datas ISO-8601 (UTC). Erros: `{ "error": { "code":
    "...", "message": "..." } }`.


    Envios respondem `{ id, message_id, wabox_id, status: "queued" }` na hora; o
    resultado chega no webhook `delivery`. `message_id` já é o id definitivo do
    WhatsApp.
  version: '1.0'
  contact: {}
servers:
  - url: https://api.wabox.me
security: []
tags:
  - name: Instance
    description: >-
      Conexão (QR code / código de pareamento), status, webhooks e configurações
      da instância.
    x-group: Instância
  - name: Messages
    description: >-
      Envio de texto, mídia, localização, contatos, reações, enquetes e ações
      sobre mensagens. Tudo passa pela fila; o resultado chega no webhook
      `delivery`.
    x-group: Mensagens
  - name: Interactive
    description: >-
      Botões, listas, carrossel, PIX, eventos de calendário, status (stories) e
      convite de canal. Best effort: renderizam no celular; o WhatsApp
      Web/Desktop não exibe botões, listas nem carrossel.
    x-group: Interativos
  - name: Queue
    description: Mensagens aguardando envio (pacing anti-ban ou instância desconectada).
    x-group: Fila
  - name: Chats
    description: >-
      Lista de conversas, ações (arquivar, silenciar, fixar, ler) e mensagens
      temporárias.
    x-group: Chats
  - name: Contacts
    description: Contatos, foto de perfil, verificação de números e bloqueio.
    x-group: Contatos
  - name: Profile
    description: Nome, recado e foto do número conectado.
    x-group: Perfil
  - name: Groups
    description: >-
      Criar, listar, administrar participantes, links de convite e
      configurações.
    x-group: Grupos
  - name: Communities
    description: Comunidades e vínculo de grupos.
    x-group: Comunidades
  - name: Newsletters
    description: >-
      Canais (newsletters): criar, seguir, ler e reagir a posts. Para publicar,
      use qualquer `send-*` com `phone: <id>@newsletter`.
    x-group: Canais
  - name: Privacy
    description: Configurações de privacidade da conta.
    x-group: Privacidade
  - name: Business
    description: >-
      Perfil comercial, catálogo de produtos, pedidos e envio de
      produto/catálogo/pedido. Best effort: depende do protocolo do WhatsApp
      Web.
    x-group: Business e catálogo
  - name: Labels
    description: Etiquetas (labels) de conversas — só em contas WhatsApp Business.
    x-group: Etiquetas
  - name: Partner
    description: >-
      Para integradores: criar e administrar instâncias do próprio workspace
      Partner com o header `Partner-Token` (base `/partner`, sem
      `instance_id`/`token` na URL). As instâncias criadas aqui são operadas
      pela API pública normal e não têm trial nem `402`.
    x-group: Partner
  - name: Webhooks
    description: Eventos entregues por `POST` na URL configurada em cada instância.
    x-group: Webhooks
paths:
  /instances/{instance_id}/token/{token}/queue:
    get:
      tags:
        - Queue
      summary: Listar mensagens na fila
      description: >-
        Mensagens enviadas pela API que ainda não saíram — normalmente porque a
        instância está desconectada (elas são entregues em ordem assim que
        reconectar). Paginado por `page`/`page_size` (máx. 100), do mais antigo
        para o mais novo. `wabox_id` é o id retornado no envio; `message_id` é o
        id que a mensagem terá no WhatsApp; `payload` é o conteúdo original.
      operationId: queue.list
      parameters:
        - name: instance_id
          required: true
          in: path
          description: Id da instância (dashboard › instância › Credenciais).
          schema:
            type: string
          example: 8f2a3c1e-6b7d-4e5f-9a0b-1c2d3e4f5a6b
        - name: token
          required: true
          in: path
          description: Token da instância. Trate como senha.
          schema:
            type: string
          example: 3A1F5C7E9B2D4F6A8C0E1B3D5F7A9C2E
        - name: page_size
          required: false
          in: query
          description: Itens por página (1–100). Padrão 20.
          schema:
            example: 20
        - name: page
          required: false
          in: query
          description: Página (a partir de 1). Padrão 1.
          schema:
            example: 1
      responses:
        '200':
          description: Página da fila.
          content:
            application/json:
              schema:
                type: object
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/QueueItem'
                  page:
                    type: integer
                    minimum: 1
                    maximum: 9007199254740991
                    description: Página atual (a partir de 1).
                  page_size:
                    type: integer
                    minimum: 1
                    maximum: 9007199254740991
                  total:
                    type: integer
                    minimum: 0
                    maximum: 9007199254740991
                    description: Total de itens em todas as páginas.
                required:
                  - data
                  - page
                  - page_size
                  - total
                additionalProperties: false
              example:
                data:
                  - wabox_id: wbx_01J5Q8ZK3M4N5P6Q7R8S9T0M01
                    message_id: 3EB0A9C6D2F1E4B5A7C8
                    phone: '5511988887777'
                    type: text
                    payload:
                      type: text
                      message: Olá do Wabox!
                    created_at: '2026-08-18T12:07:00.000Z'
                page: 1
                page_size: 20
                total: 1
        '401':
          description: Instância/token inválidos ou `Client-Token` ausente.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiError'
              example:
                error:
                  code: instance_not_found
                  message: Instance not found or invalid token
      x-codeSamples:
        - lang: typescript
          label: TypeScript (@wabox/sdk)
          source: |
            import { createWabox } from "@wabox/sdk";

            const wabox = createWabox({
              instanceId: process.env.WABOX_INSTANCE_ID!,
              token: process.env.WABOX_TOKEN!,
            });

            const { data, error } = await wabox.GET("/queue", {
              params: {
                query: { page_size: 20, page: 1 },
              },
            });
            if (error) throw new Error(error.error.message);
            console.log(data);
components:
  schemas:
    QueueItem:
      type: object
      properties:
        wabox_id:
          type: string
          description: Id retornado no envio (`wbx_…`).
        message_id:
          nullable: true
          description: Id que a mensagem terá no WhatsApp.
          type: string
        phone:
          type: string
          description: Destinatário (número ou id de grupo).
        type:
          type: string
          enum:
            - text
            - image
            - audio
            - video
            - ptv
            - gif
            - document
            - sticker
            - location
            - contact
            - contacts
            - link
            - reaction
            - poll
            - poll_vote
            - buttons
            - buttons_response
            - list
            - list_response
            - template
            - carousel
            - pix
            - event
            - event_response
            - status
            - newsletter_invite
            - product
            - order
            - payment
            - pin
            - forward
            - revoke
            - notification
            - unsupported
        payload:
          nullable: true
          description: Conteúdo original do envio.
          oneOf:
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - text
                message:
                  type: string
                  minLength: 1
                  maxLength: 65536
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
                edit_message_id:
                  type: string
                  minLength: 1
              required:
                - type
                - message
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - image
                media:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
                caption:
                  type: string
                  maxLength: 65536
                view_once:
                  type: boolean
                edit_message_id:
                  type: string
                  minLength: 1
              required:
                - type
                - media
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - video
                media:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
                caption:
                  type: string
                  maxLength: 65536
                view_once:
                  type: boolean
                edit_message_id:
                  type: string
                  minLength: 1
              required:
                - type
                - media
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - gif
                media:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
                caption:
                  type: string
                  maxLength: 65536
              required:
                - type
                - media
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - ptv
                media:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - media
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - audio
                media:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
                ptt:
                  default: true
                  type: boolean
                waveform:
                  type: boolean
                view_once:
                  type: boolean
              required:
                - type
                - media
                - ptt
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - document
                media:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
                caption:
                  type: string
                  maxLength: 65536
                edit_message_id:
                  type: string
                  minLength: 1
              required:
                - type
                - media
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - sticker
                media:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - media
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - location
                latitude:
                  type: number
                  minimum: -90
                  maximum: 90
                longitude:
                  type: number
                  minimum: -180
                  maximum: 180
                name:
                  type: string
                  maxLength: 1000
                address:
                  type: string
                  maxLength: 1000
                url:
                  type: string
                  format: uri
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - latitude
                - longitude
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - contact
                contacts:
                  minItems: 1
                  maxItems: 50
                  type: array
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                        minLength: 1
                        maxLength: 256
                      phone:
                        type: string
                        pattern: ^\d{5,20}$
                      description:
                        type: string
                        maxLength: 1000
                      vcard:
                        type: string
                        maxLength: 16384
                    required:
                      - name
                      - phone
                    additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - contacts
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - link
                message:
                  type: string
                  minLength: 1
                  maxLength: 65536
                url:
                  type: string
                  format: uri
                title:
                  type: string
                  maxLength: 1000
                description:
                  type: string
                  maxLength: 5000
                image:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - message
                - url
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - reaction
                message_id:
                  type: string
                  minLength: 1
                reaction:
                  type: string
                  maxLength: 16
                from_me:
                  type: boolean
                participant:
                  type: string
                  minLength: 1
                  pattern: >-
                    ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
              required:
                - type
                - message_id
                - reaction
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - forward
                message_id:
                  type: string
                  minLength: 1
                from_phone:
                  type: string
                  minLength: 1
                  pattern: >-
                    ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
              required:
                - type
                - message_id
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - pin
                message_id:
                  type: string
                  minLength: 1
                pin:
                  type: boolean
                duration_seconds:
                  default: 604800
                  anyOf:
                    - type: number
                      enum:
                        - 86400
                    - type: number
                      enum:
                        - 604800
                    - type: number
                      enum:
                        - 2592000
                from_me:
                  type: boolean
                participant:
                  type: string
                  minLength: 1
                  pattern: >-
                    ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
              required:
                - type
                - message_id
                - pin
                - duration_seconds
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - revoke
                message_id:
                  type: string
                  minLength: 1
                from_me:
                  type: boolean
                participant:
                  type: string
                  minLength: 1
                  pattern: >-
                    ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
              required:
                - type
                - message_id
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - poll
                question:
                  type: string
                  minLength: 1
                  maxLength: 255
                options:
                  minItems: 2
                  maxItems: 12
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 100
                poll_max_options:
                  default: 1
                  type: integer
                  minimum: 0
                  maximum: 12
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - question
                - options
                - poll_max_options
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - poll_vote
                poll_message_id:
                  type: string
                  minLength: 1
                options:
                  maxItems: 12
                  type: array
                  items:
                    type: string
                    minLength: 1
                    maxLength: 100
                from_me:
                  type: boolean
                participant:
                  type: string
                  minLength: 1
                  pattern: >-
                    ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
              required:
                - type
                - poll_message_id
                - options
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - buttons
                message:
                  type: string
                  minLength: 1
                  maxLength: 4096
                title:
                  type: string
                  maxLength: 256
                footer:
                  type: string
                  maxLength: 256
                image:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                buttons:
                  minItems: 1
                  maxItems: 10
                  type: array
                  items:
                    oneOf:
                      - type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - reply
                          id:
                            type: string
                            minLength: 1
                            maxLength: 256
                          label:
                            type: string
                            minLength: 1
                            maxLength: 60
                        required:
                          - type
                          - id
                          - label
                        additionalProperties: false
                      - type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - url
                          label:
                            type: string
                            minLength: 1
                            maxLength: 60
                          url:
                            type: string
                            format: uri
                        required:
                          - type
                          - label
                          - url
                        additionalProperties: false
                      - type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - call
                          label:
                            type: string
                            minLength: 1
                            maxLength: 60
                          phone:
                            type: string
                            pattern: ^\d{5,20}$
                        required:
                          - type
                          - label
                          - phone
                        additionalProperties: false
                      - type: object
                        properties:
                          type:
                            type: string
                            enum:
                              - copy
                          label:
                            type: string
                            minLength: 1
                            maxLength: 60
                          code:
                            type: string
                            minLength: 1
                            maxLength: 256
                        required:
                          - type
                          - label
                          - code
                        additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - message
                - buttons
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - list
                message:
                  type: string
                  minLength: 1
                  maxLength: 4096
                title:
                  type: string
                  maxLength: 256
                footer:
                  type: string
                  maxLength: 256
                button_label:
                  type: string
                  minLength: 1
                  maxLength: 20
                sections:
                  minItems: 1
                  maxItems: 10
                  type: array
                  items:
                    type: object
                    properties:
                      title:
                        type: string
                        maxLength: 24
                      rows:
                        minItems: 1
                        maxItems: 10
                        type: array
                        items:
                          type: object
                          properties:
                            id:
                              type: string
                              minLength: 1
                              maxLength: 256
                            title:
                              type: string
                              minLength: 1
                              maxLength: 24
                            description:
                              type: string
                              maxLength: 72
                          required:
                            - id
                            - title
                          additionalProperties: false
                    required:
                      - rows
                    additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - message
                - button_label
                - sections
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - carousel
                message:
                  type: string
                  minLength: 1
                  maxLength: 4096
                cards:
                  minItems: 1
                  maxItems: 10
                  type: array
                  items:
                    type: object
                    properties:
                      image:
                        type: object
                        properties:
                          url:
                            type: string
                            format: uri
                          base64:
                            type: string
                            minLength: 1
                          mime_type:
                            type: string
                            minLength: 1
                            maxLength: 255
                          file_name:
                            type: string
                            minLength: 1
                            maxLength: 255
                        additionalProperties: false
                      title:
                        type: string
                        maxLength: 256
                      text:
                        type: string
                        minLength: 1
                        maxLength: 1024
                      footer:
                        type: string
                        maxLength: 256
                      buttons:
                        default: []
                        maxItems: 3
                        type: array
                        items:
                          oneOf:
                            - type: object
                              properties:
                                type:
                                  type: string
                                  enum:
                                    - reply
                                id:
                                  type: string
                                  minLength: 1
                                  maxLength: 256
                                label:
                                  type: string
                                  minLength: 1
                                  maxLength: 60
                              required:
                                - type
                                - id
                                - label
                              additionalProperties: false
                            - type: object
                              properties:
                                type:
                                  type: string
                                  enum:
                                    - url
                                label:
                                  type: string
                                  minLength: 1
                                  maxLength: 60
                                url:
                                  type: string
                                  format: uri
                              required:
                                - type
                                - label
                                - url
                              additionalProperties: false
                            - type: object
                              properties:
                                type:
                                  type: string
                                  enum:
                                    - call
                                label:
                                  type: string
                                  minLength: 1
                                  maxLength: 60
                                phone:
                                  type: string
                                  pattern: ^\d{5,20}$
                              required:
                                - type
                                - label
                                - phone
                              additionalProperties: false
                            - type: object
                              properties:
                                type:
                                  type: string
                                  enum:
                                    - copy
                                label:
                                  type: string
                                  minLength: 1
                                  maxLength: 60
                                code:
                                  type: string
                                  minLength: 1
                                  maxLength: 256
                              required:
                                - type
                                - label
                                - code
                              additionalProperties: false
                    required:
                      - image
                      - text
                      - buttons
                    additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - message
                - cards
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - pix
                key:
                  type: string
                  minLength: 1
                  maxLength: 256
                key_type:
                  type: string
                  enum:
                    - cpf
                    - cnpj
                    - phone
                    - email
                    - evp
                name:
                  type: string
                  minLength: 1
                  maxLength: 100
                message:
                  type: string
                  maxLength: 4096
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - key
                - key_type
                - name
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - event
                name:
                  type: string
                  minLength: 1
                  maxLength: 256
                description:
                  type: string
                  maxLength: 2048
                start_at:
                  type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                end_at:
                  type: string
                  format: date-time
                  pattern: >-
                    ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z|([+-](?:[01]\d|2[0-3]):[0-5]\d)))$
                location:
                  type: object
                  properties:
                    name:
                      type: string
                      maxLength: 256
                    latitude:
                      type: number
                      minimum: -90
                      maximum: 90
                    longitude:
                      type: number
                      minimum: -180
                      maximum: 180
                  additionalProperties: false
                join_link:
                  type: string
                  format: uri
                extra_guests_allowed:
                  type: boolean
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
                edit_message_id:
                  type: string
                  minLength: 1
                canceled:
                  type: boolean
              required:
                - type
                - name
                - start_at
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - event_response
                event_message_id:
                  type: string
                  minLength: 1
                response:
                  type: string
                  enum:
                    - going
                    - not_going
                    - maybe
                extra_guests:
                  type: integer
                  minimum: 0
                  maximum: 99
                from_me:
                  type: boolean
                participant:
                  type: string
                  minLength: 1
                  pattern: >-
                    ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
              required:
                - type
                - event_message_id
                - response
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - status
                status_type:
                  type: string
                  enum:
                    - text
                    - image
                    - video
                message:
                  type: string
                  maxLength: 65536
                media:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                background_color:
                  type: string
                  pattern: ^#?[0-9a-fA-F]{6}$
                font:
                  type: integer
                  minimum: 0
                  maximum: 9
              required:
                - type
                - status_type
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - newsletter_invite
                newsletter_id:
                  type: string
                  pattern: ^\d+@newsletter$
                caption:
                  type: string
                  maxLength: 1024
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - newsletter_id
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - product
                product_id:
                  type: string
                  minLength: 1
                business_phone:
                  type: string
                  minLength: 1
                  pattern: >-
                    ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                message:
                  type: string
                  maxLength: 1024
                footer:
                  type: string
                  maxLength: 60
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - product_id
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - catalog
                business_phone:
                  type: string
                  minLength: 1
                  pattern: >-
                    ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                message:
                  type: string
                  maxLength: 4096
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
              additionalProperties: false
            - type: object
              properties:
                type:
                  type: string
                  enum:
                    - order
                order_id:
                  type: string
                  minLength: 1
                  maxLength: 64
                title:
                  type: string
                  minLength: 1
                  maxLength: 256
                item_count:
                  default: 1
                  type: integer
                  minimum: 1
                  maximum: 9999
                total:
                  type: number
                  minimum: 0
                  maximum: 1000000000
                currency:
                  type: string
                  pattern: ^[A-Z]{3}$
                status:
                  default: inquiry
                  type: string
                  enum:
                    - inquiry
                    - accepted
                    - declined
                message:
                  type: string
                  maxLength: 1024
                token:
                  type: string
                  maxLength: 512
                seller_phone:
                  type: string
                  minLength: 1
                  pattern: >-
                    ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                order_request_message_id:
                  type: string
                  minLength: 1
                thumbnail:
                  type: object
                  properties:
                    url:
                      type: string
                      format: uri
                    base64:
                      type: string
                      minLength: 1
                    mime_type:
                      type: string
                      minLength: 1
                      maxLength: 255
                    file_name:
                      type: string
                      minLength: 1
                      maxLength: 255
                  additionalProperties: false
                reply_to_message_id:
                  type: string
                  minLength: 1
                mentioned:
                  maxItems: 500
                  type: array
                  items:
                    type: string
                    minLength: 1
                    pattern: >-
                      ^(\d{5,20}|\d+@lid|\d+(-\d+)?-group|\d+@g\.us|\d+@newsletter|\d+@broadcast|status@broadcast)$
                mention_all:
                  type: boolean
              required:
                - type
                - order_id
                - title
                - item_count
                - total
                - currency
                - status
              additionalProperties: false
        created_at:
          type: string
          description: ISO-8601 (UTC).
      required:
        - wabox_id
        - message_id
        - phone
        - type
        - payload
        - created_at
      additionalProperties: false
    ApiError:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              description: >-
                Código estável do erro (`instance_not_found`,
                `invalid_request`…).
            message:
              type: string
              description: Descrição legível, em inglês.
            details:
              description: 'Contexto extra (ex.: `issues` de validação).'
              type: object
              additionalProperties: {}
          required:
            - code
            - message
          additionalProperties: false
      required:
        - error
      additionalProperties: false

````