Números

Obter número (detalhes Meta)

Retorna o número + todas as informações da Meta quando for um número da API oficial: bloco meta aninhado (phone / profile / waba, camelCase) com qualidade, tier de mensagens, status de verificação, perfil de negócio e dados da WABA, além de health. Servido do cache por padrão; passe ?refresh=1 para buscar ao vivo no Graph da Meta e persistir. Número não-Meta retorna meta: null. (A mesma rota aceita DELETE para remover; use GET /api/v1/numbers/:id/status para um poll leve só de estado.)

GET

numbers

{id}

curl --request GET \
  --url https://pilotstatus.com.br/v1/numbers/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "num_01HZX...",
  "number": "+5511999999999",
  "name": "Atendimento",
  "provider": "META",
  "state": "OPEN",
  "isFullyConnected": true,
  "health": {
    "qualityRating": "GREEN",
    "messagingLimitTier": "TIER_2K",
    "metaStatus": "CONNECTED",
    "sendable": true
  },
  "meta": {
    "fetchedAt": "2026-06-30T08:55:00.000Z",
    "phone": {
      "displayPhoneNumber": "+55 11 99999-9999",
      "verifiedName": "Minha Empresa",
      "qualityRating": "GREEN",
      "status": "CONNECTED",
      "codeVerificationStatus": "VERIFIED",
      "nameStatus": "APPROVED",
      "platformType": "CLOUD_API",
      "throughput": {
        "level": "STANDARD"
      },
      "messagingLimitTier": "TIER_2K",
      "businessManagerMessagingLimit": "TIER_2K",
      "accountMode": "LIVE"
    },
    "profile": {
      "about": "Atendimento oficial",
      "email": "contato@empresa.com",
      "websites": [
        "https://empresa.com"
      ],
      "vertical": "PROF_SERVICES"
    },
    "waba": {
      "id": "1234567890",
      "name": "Empresa WABA",
      "currency": "BRL",
      "businessVerificationStatus": "verified",
      "accountReviewStatus": "APPROVED",
      "ownershipType": "CLIENT"
    },
    "errors": {}
  }
}

Autorizações

x-api-key

string

header

obrigatório

Sua chave de API ps_

Parâmetros de caminho

string

obrigatório

Id do número WhatsApp.

Parâmetros de consulta

refresh

string

Passe 1 para forçar uma busca ao vivo no Graph da Meta e atualizar o cache.

Resposta

Obter número Meta

Pareamento remoto (link de conexão)

Remover número

⌘I

Obter número (detalhes Meta)

curl --request GET \
  --url https://pilotstatus.com.br/v1/numbers/{id} \
  --header 'x-api-key: <api-key>'

{
  "id": "num_01HZX...",
  "number": "+5511999999999",
  "name": "Atendimento",
  "provider": "META",
  "state": "OPEN",
  "isFullyConnected": true,
  "health": {
    "qualityRating": "GREEN",
    "messagingLimitTier": "TIER_2K",
    "metaStatus": "CONNECTED",
    "sendable": true
  },
  "meta": {
    "fetchedAt": "2026-06-30T08:55:00.000Z",
    "phone": {
      "displayPhoneNumber": "+55 11 99999-9999",
      "verifiedName": "Minha Empresa",
      "qualityRating": "GREEN",
      "status": "CONNECTED",
      "codeVerificationStatus": "VERIFIED",
      "nameStatus": "APPROVED",
      "platformType": "CLOUD_API",
      "throughput": {
        "level": "STANDARD"
      },
      "messagingLimitTier": "TIER_2K",
      "businessManagerMessagingLimit": "TIER_2K",
      "accountMode": "LIVE"
    },
    "profile": {
      "about": "Atendimento oficial",
      "email": "contato@empresa.com",
      "websites": [
        "https://empresa.com"
      ],
      "vertical": "PROF_SERVICES"
    },
    "waba": {
      "id": "1234567890",
      "name": "Empresa WABA",
      "currency": "BRL",
      "businessVerificationStatus": "verified",
      "accountReviewStatus": "APPROVED",
      "ownershipType": "CLIENT"
    },
    "errors": {}
  }
}