> ## Documentation Index
> Fetch the complete documentation index at: https://docs.pilotstatus.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Obter mensagem

> Retorna o status e os timestamps de uma mensagem. O {id} pode ser o id interno da mensagem, o correlationId ou o id da mensagem no provedor (externalMessageId / wamid da Meta). Inclui externalMessageId, status, destino, sentAt/deliveredAt/readAt, errorCode e errorMessage quando falhou, origin e metaPricing. Requer key escopada a número.

**Requer uma chave com escopo de número.**



## OpenAPI

````yaml openapi.pt.json GET /v1/messages/{id}
openapi: 3.1.0
info:
  title: API Pilot Status
  version: 1.0.0
  license:
    name: Pilot Status Terms of Service
    url: https://pilotstatus.com.br/terms
  description: >-
    API REST pública do Pilot Status. Autentique com o header `x-api-key:
    ps_...` (ou `x-api-key-id`). Base URL: https://pilotstatus.com.br
servers:
  - url: https://pilotstatus.com.br
security:
  - apiKey: []
  - apiKeyId: []
paths:
  /v1/messages/{id}:
    get:
      tags:
        - Messages
      summary: Obter mensagem
      description: >-
        Retorna o status e os timestamps de uma mensagem. O {id} pode ser o id
        interno da mensagem, o correlationId ou o id da mensagem no provedor
        (externalMessageId / wamid da Meta). Inclui externalMessageId, status,
        destino, sentAt/deliveredAt/readAt, errorCode e errorMessage quando
        falhou, origin e metaPricing. Requer key escopada a número.


        **Requer uma chave com escopo de número.**
      operationId: get_messages_id
      parameters:
        - name: id
          in: path
          required: true
          description: Id interno, correlationId ou externalMessageId (wamid da Meta).
          schema:
            type: string
          example: msg_01HZX...
      responses:
        '200':
          description: Obter mensagem
          content:
            application/json:
              schema:
                type: object
                properties:
                  id:
                    type: string
                    description: >-
                      Id interno da mensagem — o `id` devolvido por `POST
                      /v1/messages/send`.
                    example: msg_01HZX...
                  externalMessageId:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Id da mensagem no provedor (num número oficial, o wamid da
                      Meta). `null` até o provedor aceitar a mensagem.
                    example: wamid.HBg...
                  status:
                    type: string
                    enum:
                      - QUEUED
                      - SENT
                      - DELIVERED
                      - READ
                      - PLAYED
                      - FAILED
                      - CANCELED
                    description: Status de entrega atual.
                    example: FAILED
                  correlationId:
                    type: string
                    description: Identificador de correlação do envio.
                    example: corr_01HZX...
                  destinationNumber:
                    type: string
                    description: Número de telefone de destino.
                    example: '5511988887777'
                  createdAt:
                    type: string
                    format: date-time
                    description: Quando a mensagem foi criada (UTC, ISO 8601).
                    example: '2026-06-20T10:00:00.000Z'
                  sentAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Quando a mensagem foi enviada, ou `null`.
                    example: '2026-06-20T10:00:01.000Z'
                  deliveredAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Quando a mensagem foi entregue, ou `null`.
                    example: null
                  readAt:
                    type:
                      - string
                      - 'null'
                    format: date-time
                    description: Quando a mensagem foi lida, ou `null`.
                    example: null
                  errorCode:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Motivo da falha legível por máquina — o mesmo valor que
                      `GET /v1/messages` devolve para esta mensagem. `null`
                      quando não há erro, e sempre `null` em `DELIVERED`,
                      `READ`, `PLAYED` e `CANCELED`. Ramifique por ele, nunca
                      pelo `errorMessage`. O conjunto cresce (veja Códigos de
                      Erro do Log): trate um código desconhecido como "precisa
                      de revisão".
                    example: META_OUTSIDE_24H_WINDOW
                  errorMessage:
                    type:
                      - string
                      - 'null'
                    description: >-
                      Motivo da falha legível por pessoas, ou `null`. A redação
                      não é contrato — não faça parsing; use o `errorCode`.
                    example: >-
                      Re-engagement message: Message failed to send because more
                      than 24 hours have passed since the customer last replied
                      to this number.
                  template:
                    type: string
                    description: >-
                      Nome do template com que a mensagem foi enviada. A chave é
                      omitida (não `null`) quando o envio não usou template.
                    example: boas_vindas
                  origin:
                    type:
                      - string
                      - 'null'
                    enum:
                      - API
                      - MCP
                      - CHATWOOT
                      - CHAT
                      - DASHBOARD
                      - SYSTEM
                      - null
                    description: >-
                      Por onde a mensagem saiu. `null` quer dizer que não há
                      requisição de envio reconhecida — não quer dizer recebida.
                      Mensagens enviadas que não passaram pela Pilot Status —
                      `APP`, `LAYER` e respostas `CHATWOOT` de uma inbox nativa
                      WhatsApp Cloud — só aparecem em `GET /v1/messages` e `GET
                      /v1/messages/history`; este endpoint responde 404 para
                      elas.
                    example: API
                  metaPricing:
                    type:
                      - object
                      - 'null'
                    description: >-
                      O veredito de cobrança da própria Meta para esta mensagem.
                      `null` enquanto a Meta não reportar, e sempre `null` em
                      números que não são Meta.
                    properties:
                      conversationId:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Id da janela de cobrança de 24h da Meta (não é id de
                          conversa).
                        example: b1f2...
                      originType:
                        type:
                          - string
                          - 'null'
                        description: >-
                          Como essa janela abriu: `marketing`, `utility`,
                          `authentication`, `service` ou `referral_conversion`.
                        example: utility
                      category:
                        type:
                          - string
                          - 'null'
                        description: >-
                          A categoria que a Meta cobrou. Mesmo conjunto de
                          valores de `originType`.
                        example: utility
                      type:
                        type:
                          - string
                          - 'null'
                        description: >-
                          `regular` = cobrada; `free_entry_point` (clique em
                          anúncio) e `free_customer_service` = não cobradas.
                        example: regular
              example:
                id: msg_01HZX...
                externalMessageId: wamid.HBg...
                status: DELIVERED
                correlationId: corr_01HZX...
                destinationNumber: '5511988887777'
                createdAt: '2026-06-20T10:00:00.000Z'
                sentAt: '2026-06-20T10:00:01.000Z'
                deliveredAt: '2026-06-20T10:00:03.000Z'
                readAt: null
                errorCode: null
                errorMessage: null
                template: boas_vindas
                origin: API
                metaPricing: null
        '400':
          description: Payload ou parâmetros inválidos
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Validation error
        '401':
          description: Header `x-api-key` / `x-api-key-id` ausente ou inválido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Unauthorized
        '403':
          description: Chave com escopo de tenant usada em endpoint com escopo de número
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Tenant-scoped keys cannot call number endpoints
                code: TENANT_SCOPE_NOT_ALLOWED
        '429':
          description: Limite de taxa excedido
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                  code:
                    type: string
              example:
                error: Too many requests
components:
  securitySchemes:
    apiKey:
      type: apiKey
      in: header
      name: x-api-key
      description: Sua chave de API ps_
    apiKeyId:
      type: apiKey
      in: header
      name: x-api-key-id
      description: Id da chave de API (alternativa ao x-api-key)

````

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