WhatsApp APIAPI
WhatsApp: listar os números
Liste os números de WhatsApp do workspace conectados pela API oficial da Meta e pegue o id que vai em numberId nos envios.
Atualizado em
GET /whatsapp/numbers devolve os números de WhatsApp do workspace. O id de cada um vai em numberId nos envios de templates e de mensagens.
Listar os números
GET https://api.xbase.app/api/external/v1/whatsapp/numberscurl https://api.xbase.app/api/external/v1/whatsapp/numbers \
-H "Authorization: Bearer $XBASE_API_KEY"Resposta 200:
[
{
"id": "6d1f3c2a-4b5e-4f60-9a7b-8c9d0e1f2a3b",
"phone": "5511999990000",
"name": "Atendimento",
"status": "ACTIVE"
}
]| Campo | Tipo | Descrição |
|---|---|---|
id | texto | Id do número na XBASE. Vai em numberId |
phone | texto ou null | Número que envia, só dígitos, com DDI |
name | texto ou null | Nome de exibição do número |
status | texto | ACTIVE envia. INACTIVE está desconectado: os envios por ele respondem 422 NUMBER_DISCONNECTED |
A lista vem na ordem em que os números foram conectados. Número removido em WhatsApp API → Números não aparece.
Erros
| Status | code | Quando |
|---|---|---|
| 401 | INVALID_API_KEY | Sem chave, chave em formato errado, inexistente ou revogada |
| 403 | MISSING_SCOPE | A chave não tem o escopo whatsapp:send |
Veja o formato completo em Erros.