Pular para o conteúdo principal
GET
Consultar um número

Autorizações

Authorization
string
header
obrigatório

Autentique com uma chave secreta (sk_live_…) ou uma chave restrita (rk_live_…) criada no painel. Chaves restritas só têm as permissões escolhidas na criação, como messages:send, chats:read ou broadcasts:send.

Cabeçalhos

Blu-Version
string

A versão da API a usar. Por padrão, é a versão fixada na sua conta.

Exemplo:

"2026-10-11"

Parâmetros de caminho

phone_number
string
obrigatório
Pattern: ^pn_

Parâmetros de consulta

expand[]
string[]

Campos a expandir em objetos completos, como contact, ou data.contact em listas.

Resposta

O número.

id
string
obrigatório
Pattern: ^pn_
Exemplo:

"pn_8f3aK1"

object
string
obrigatório
Allowed value: "phone_number"
name
string
obrigatório

O nome que você deu ao número.

display_phone_number
string | null
obrigatório
Exemplo:

"+55 11 99999-8888"

wa_id
string | null
obrigatório

Nulo até o número ser conectado pela primeira vez.

Exemplo:

"5511999998888"

verified_name
string | null
obrigatório

O nome comercial ou de perfil no WhatsApp.

platform_type
enum<string>
obrigatório

A plataforma do número. Hoje, todos os números usam a API do WhatsApp Cloud, da Meta.

Opções disponíveis:
cloud_api
status
enum<string>
obrigatório

pending_link nunca foi conectado. connecting está conectando ou reconectando. connected pode enviar e receber. disconnected foi desconectado e precisa ser conectado de novo.

Opções disponíveis:
pending_link,
connecting,
connected,
disconnected
quality_rating
enum<string> | null
obrigatório

A classificação de qualidade da Meta. Nula até a Meta classificar o número.

Opções disponíveis:
GREEN,
YELLOW,
RED,
UNKNOWN,
null
capabilities
object
obrigatório

O que este número permite. Confira antes de usar recursos que mudam conforme o tipo de plataforma.

agent
obrigatório

O agente que responde às conversas deste número. Expansível.

Pattern: ^agent_
created
integer
obrigatório

Horário Unix em segundos.

Exemplo:

1760190012