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

# Consultar o status de uma campanha

> Veja como está uma campanha enviada para `POST /v2/send-campaign`: se ainda está pendente, já foi capturada para processamento, ou terminou, junto com o status de cada implantação individual em que foi expandida.

<Warning>
  Lembre-se que para usar este endpoint, você deve ter obtido sua chave de API na seção de **Desenvolvedores** da plataforma Treble.
</Warning>

Use o `launch_request_id` retornado por [Enviar uma campanha](/pt/api-reference/endpoints/send-campaign) para saber se ainda está `PENDING`, já foi capturada para processamento (`CLAIMED`), ou terminou (`DONE`) — junto com o status de cada implantação individual em que foi expandida.

## Valores do status da implantação

Cada item em `deployments` tem seu próprio `status`, que é `null` até o Conversation Runtime capturá-lo. A partir daí, ele passa por um destes valores:

| Status | Significado |
| - | - |
| `RECEIVED` | O Conversation Runtime recebeu a implantação e está prestes a enviá-la. |
| `RECEIVED_BY_WORKER` | Um worker a capturou e está processando. |
| `RETRY` | Ocorreu uma falha transitória e a implantação está sendo reenviada. |
| `SUCCESS` | A mensagem foi enviada com sucesso (a entrega ainda não foi confirmada pelo WhatsApp). |
| `DELIVERED` | O WhatsApp confirmou que a mensagem foi entregue ao dispositivo do usuário. |
| `PUSH_NOTIFICATION` (também aparece com o typo `PUSH_NOTIFATION`) | Enviada como notificação push em vez de uma mensagem do WhatsApp. |
| `REVOKED` | A implantação foi cancelada antes de ser enviada. |
| `VALIDATION_ERROR` | Os dados da implantação não passaram na validação antes do envio. |
| `INVALID_PHONE` | O celular não é válido ou não tem WhatsApp. |
| `INVALID_POLL` | Tentou-se enviar uma conversa eliminada ou desativada. |
| `MISSING_PARAMETER` | Faltou uma variável obrigatória no template HSM. |
| `PARAMETER_MISMATCH` | O número de variáveis enviadas não coincide com as do template HSM. |
| `CHARACTER_LIMIT_HEADER` | O cabeçalho do template HSM excede o limite de caracteres permitido pelo WhatsApp. |
| `CHARACTER_LIMIT_BODY` | O corpo do template HSM excede o limite de caracteres permitido pelo WhatsApp. |
| `FAILURE` | A implantação falhou após 3 tentativas. |
| `FAILURE_BY_HUMAN_HANDOVER` | O usuário está falando com um agente, então a mensagem automática não foi enviada. |
| `FAILURE_BY_RATE_LIMIT` | Enviar a mensagem excederia o limite de envios permitido pelo WhatsApp. |
| `COMPANY_RATE_LIMIT` | Excedeu o limite de sessões configurado pela empresa. |
| `FAILURE_BY_TIER_CAPACITY` | Nenhuma linha do WhatsApp tinha capacidade suficiente para fazer a implantação. |
| `FAILURE_BY_BLOCKED_CONTACT` | O contato foi bloqueado pela empresa. |
| `FAILURE_BY_OPTOUT_CONTACT` | O contato optou por não receber mais comunicações da empresa. |
| `FAILURE_BY_DISABLED_HSM` | O Meta desabilitou o template HSM que foi enviado. |
| `FAILURE_BY_SPAM_RATE_LIMIT` | O WhatsApp restringiu a linha por spam; ela não pode enviar mais mensagens no momento. |
| `FAILURE_BY_EXPERIMENT_NUMBER` | O WhatsApp está usando esse número para experimentos internos, então a implantação não pôde ser realizada. |
| `FAILURE_BY_META_CHOSE_NOT_DELIVER` | As heurísticas internas do Meta decidiram não entregar a mensagem. |
| `FAILURE_BY_TEST_CHANNEL` | A linha é um canal de teste e não pode enviar implantações reais. |
| `FAILURE_BY_MEDIA_UPLOAD_ERROR` | O arquivo de mídia anexado falhou ao ser enviado para o WhatsApp. |
| `FAILURE_BY_DEPLOYMENT_LIMIT_REACHED` | A empresa atingiu seu limite de implantações. |
| `FAILURE_BY_UNABLE_TO_CONTACT` | O WhatsApp não conseguiu contatar o dispositivo do usuário naquele momento — geralmente é temporário. Veja a [explicação completa](/pt/docs/meta/error-descriptions/failure-by-unable-to-contact). |
| `FAILURE_BY_PAYMENT_ISSUE` | O Meta rejeitou o envio do template por um problema de pagamento na conta do WhatsApp Business. Veja a [explicação completa](/pt/docs/meta/error-descriptions/failure-by-payment-issue). |


## OpenAPI

````yaml open-api-files/treble-api-pt.json GET /v2/send-campaign/{launch_request_id}
openapi: 3.0.1
info:
  title: API do Treble Poll
  description: Documentação para o endpoint de implantação de polls no Treble
  version: 1.0.0
servers:
  - url: https://main.treble.ai
    description: Servidor principal do Treble
  - url: https://seudominio.com
    description: >-
      Servidor de exemplo para implementar os webhooks. Isso representa SEU
      servidor onde você deve implementar os endpoints que o Treble chamará.
security: []
tags:
  - name: Webhooks
    description: >-
      Endpoints que o Treble chamará no seu servidor. Estes não são endpoints
      reais que você possa chamar, mas uma representação dos webhooks que o
      Treble invocará no seu sistema.
paths:
  /v2/send-campaign/{launch_request_id}:
    servers:
      - url: https://campaign-orchestration.treble.ai
        description: Servidor do Campaign Orchestration
    get:
      summary: Consultar o status de uma campanha
      description: >-
        Veja como está uma campanha enviada para `POST /v2/send-campaign`: se
        ainda está pendente, já foi capturada para processamento, ou terminou,
        junto com o status de cada implantação individual em que foi expandida.
      parameters:
        - name: launch_request_id
          in: path
          required: true
          description: O `launch_request_id` retornado ao enviar a campanha
          schema:
            type: string
            format: uuid
        - name: Authorization
          in: header
          required: true
          description: Chave de API de autorização
          schema:
            type: string
          example: API_KEY
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                properties:
                  launch_request_id:
                    type: string
                  status:
                    type: string
                    enum:
                      - PENDING
                      - CLAIMED
                      - DONE
                      - FAILED_EXPANSION
                      - FAILED_POLICY
                  poll_id:
                    type: integer
                  deployments:
                    type: array
                    items:
                      type: object
                      properties:
                        conversation_id:
                          type: string
                        treble_id:
                          type: string
                        cellphone:
                          type: string
                        business_scope_id:
                          type: string
                        username:
                          type: string
                        status:
                          type: string
                          enum:
                            - RECEIVED
                            - RECEIVED_BY_WORKER
                            - RETRY
                            - SUCCESS
                            - DELIVERED
                            - FAILURE
                            - FAILURE_BY_HUMAN_HANDOVER
                            - REVOKED
                            - VALIDATION_ERROR
                            - INVALID_PHONE
                            - FAILURE_BY_RATE_LIMIT
                            - COMPANY_RATE_LIMIT
                            - FAILURE_BY_TIER_CAPACITY
                            - MISSING_PARAMETER
                            - PARAMETER_MISMATCH
                            - FAILURE_BY_BLOCKED_CONTACT
                            - FAILURE_BY_OPTOUT_CONTACT
                            - INVALID_POLL
                            - CHARACTER_LIMIT_HEADER
                            - CHARACTER_LIMIT_BODY
                            - FAILURE_BY_DISABLED_HSM
                            - FAILURE_BY_SPAM_RATE_LIMIT
                            - FAILURE_BY_UNABLE_TO_CONTACT
                            - FAILURE_BY_EXPERIMENT_NUMBER
                            - FAILURE_BY_META_CHOSE_NOT_DELIVER
                            - FAILURE_BY_TEST_CHANNEL
                            - FAILURE_BY_MEDIA_UPLOAD_ERROR
                            - FAILURE_BY_DEPLOYMENT_LIMIT_REACHED
                            - FAILURE_BY_PAYMENT_ISSUE
                            - PUSH_NOTIFICATION
                            - PUSH_NOTIFATION
                          nullable: true
                          description: >-
                            null enquanto está na fila. Veja o detalhamento
                            completo de cada valor nesta mesma página.
              example:
                launch_request_id: 59d7ef01-4518-444f-816e-1c45c1748974
                status: DONE
                poll_id: 1251072
                deployments:
                  - conversation_id: 671a1a2e2e2e2e2e2e2e2e2e
                    treble_id: abc123
                    cellphone: '3051234567'
                    business_scope_id: null
                    username: null
                    status: SENT
        '404':
          description: >-
            Não existe uma solicitação de lançamento com este id para esta
            empresa
          content:
            application/json:
              schema:
                type: object
                properties:
                  detail:
                    type: string
              example:
                detail: >-
                  Não existe uma solicitação de lançamento com este id para esta
                  empresa

````

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