Consultar fila async de envio direto

GET /message/async

Retorna um resumo simples da fila de envio async=true da instância atual autenticada.

Este endpoint cobre apenas mensagens diretas enviadas com async=true. Ele não representa:

• campanhas de envio em massa do sender (/sender/*)

A resposta padrão foi pensada para clientes:

• status: visão resumida da fila (idle, queued, processing, waiting_connection, waiting_warmup, waiting_history, resetting)
• pending: quantidade total estimada de mensagens pendentes
• processingNow: indica se uma mensagem está sendo processada neste momento
• acceptingNewMessages: indica se a fila aceita novos envios async
• sessionReady: indica se a sessão WhatsApp está pronta para envio
• resetting: indica se a fila está pausada por reset/clear

Autenticação

[
  {
    "token": []
  }
]

{
  "token": {
    "name": "token",
    "type": "apiKey",
    "in": "header"
  }
}

Respostas

{
  "200": {
    "description": "Resumo da fila async",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "response": {
              "type": "string",
              "example": "Async queue status"
            },
            "instanceId": {
              "type": "string",
              "description": "ID da instância"
            },
            "queue": {
              "type": "object",
              "properties": {
                "status": {
                  "type": "string",
                  "description": "Estado resumido da fila",
                  "enum": [
                    "idle",
                    "queued",
                    "processing",
                    "waiting_connection",
                    "waiting_warmup",
                    "waiting_history",
                    "resetting"
                  ],
                  "example": "waiting_connection"
                },
                "pending": {
                  "type": "integer",
                  "format": "int64",
                  "description": "Quantidade total estimada de mensagens pendentes",
                  "example": 3
                },
                "processingNow": {
                  "type": "boolean",
                  "description": "Indica se há uma mensagem sendo processada agora",
                  "example": true
                },
                "acceptingNewMessages": {
                  "type": "boolean",
                  "description": "Indica se a fila aceita novos envios async",
                  "example": true
                },
                "sessionReady": {
                  "type": "boolean",
                  "description": "Indica se a sessão WhatsApp está pronta para envio",
                  "example": false
                },
                "historyReady": {
                  "type": "boolean",
                  "description": "Indica se o histórico necessário para processar a fila está pronto",
                  "example": true
                },
                "warmupRemainingMs": {
                  "type": "integer",
                  "format": "int64",
                  "description": "Tempo estimado restante da preparação da sessão, em milissegundos",
                  "example": 1500
                },
                "resetting": {
                  "type": "boolean",
                  "description": "Indica se a fila async está pausada por reset/clear",
                  "example": false
                }
              }
            }
          }
        }
      }
    }
  },
  "401": {
    "description": "Token inválido ou ausente"
  },
  "500": {
    "description": "Erro interno ao consultar a fila async",
    "content": {
      "application/json": {
        "schema": {
          "type": "object",
          "properties": {
            "error": {
              "type": "string"
            },
            "instanceId": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Guias relacionados

Autenticação · Erros e retries · Server URL