Pular para o conteúdo principal

​
Criar, conectar e excluir números

Crie um número de WhatsApp via API pública, conecte-o (QR code ou código de pareamento) e exclua-o quando não for mais necessário.
Use uma chave de API com escopo de tenant (recomendada para plataformas SaaS que gerenciam múltiplos números). Uma chave com escopo de número também funciona, com o comportamento de linkToApiKey descrito abaixo. Autentique com x-api-key: ps_....

​
POST /v1/numbers — Criar um número

curl -X POST "https://pilotstatus.com.br/v1/numbers" \
  -H "Content-Type: application/json" \
  -H "x-api-key: ps_your_token_here" \
  -d '{
    "name": "My WhatsApp",
    "number": "+5511999999999",
    "linkToApiKey": true
  }'
​
name
string
obrigatório
Nome de exibição do número.
​
number
string
obrigatório
O número de telefone no formato E.164 (ex.: +5511999999999).
​
linkToApiKey
boolean
padrão:"true"
Afeta apenas chaves com escopo de número. Quando você cria um número com uma chave com escopo de número e linkToApiKey é true, essa chave é reapontada para o novo número, de modo que os envios sejam roteados para ele. Com uma chave com escopo de tenant, o parâmetro não tem efeito — uma chave com escopo de tenant nunca é vinculada (linkedApiKeyId: null).
A resposta inclui qrcodeBase64 e pairingCode (código de pareamento por letras do WhatsApp; pode ser null se o provedor não retornar um). Mostre o QR code para a pessoa dona do telefone, ou deixe-a digitar o código de pareamento.
Chame estes endpoints apenas a partir do seu backend — nunca exponha sua chave ps_ no navegador.

​
Números Meta (API oficial da Cloud)

POST /v1/numbers cria um número não oficial (pareado por QR). Para números oficiais da Meta Cloud API, use um dos fluxos Meta em vez disso:
  • POST /v1/numbers/meta — BYO-WABA direto: traga suas próprias credenciais de WABA, ou
  • Meta Embedded Signup hospedado via um link de pareamento remoto com metaFlow.

​
GET /v1/numbers//connect — Regenerar o QR code

Gera um novo QR code e código de pareamento quando a instância não está OPEN. 
curl "https://pilotstatus.com.br/v1/numbers/wa_abc/connect" \
  -H "x-api-key: ps_your_token_here"
  • A resposta inclui qrcodeBase64 e pairingCode novos.
  • Se o número já estiver conectado (OPEN), o endpoint retorna 409 — não há nada para parear.
  • Não se aplica a números Meta (eles não usam pareamento por QR).
  • Reflete o mesmo estado de conexão que a página de Números no painel.

​
DELETE /v1/numbers/ — Remover um número

curl -X DELETE "https://pilotstatus.com.br/v1/numbers/wa_abc" \
  -H "x-api-key: ps_your_token_here"
Remove o registro da Pilot Status e tenta encerrar ou remover a sessão de WhatsApp associada quando aplicável (HTTP 404 das etapas de limpeza é ignorado).

​
Webhooks relacionados

  • number.created — dispara quando a instância é criada.
  • number.connected — dispara quando o cliente completa a conexão via QR / pareamento (estado OPEN).
  • number.removed — dispara na exclusão.
Consulte a referência de eventos de webhook.