Pular para o conteúdo
WbizTool

API v2 (beta)

Verificação de números

Uma verificação de números descobre quais números de telefone têm uma conta de WhatsApp, sem enviar nada a eles. Limpe uma lista antes de uma campanha ou verifique o número de um cadastro antes de mandar mensagem. As verificações feitas pela API são as mesmas listas da página Verificação de números do painel.

OperaçãoEndpointPermissão
Iniciar uma verificaçãoPOST /api/v2/number-checkscontacts
Listar verificaçõesGET /api/v2/number-checkscontacts
Obter uma verificaçãoGET /api/v2/number-checks/{id}contacts
Obter os resultadosGET /api/v2/number-checks/{id}/resultscontacts

Iniciar uma verificação exige um plano que inclua a verificação de números; caso contrário, a resposta é 403 plan_required. Ler as verificações funciona em qualquer plano.

Iniciar uma verificação#

POSThttps://wbiztool.com/api/v2/number-checks

Corpo: JSON (application/json)

Os números entram na fila e a resposta é 201 com a verificação no status pending. Um número de WhatsApp conectado do seu espaço de trabalho os verifica nos minutos seguintes. Consulte a verificação periodicamente até que status seja completed e então leia os resultados.

Corpo

numbersarray of stringsobrigatório

Os números a verificar, de 1 a 10.000 entradas. Escreva-os em formato internacional com + (+919876543210). Um número sem código do país recebe o do espaço de trabalho. Repetidos são verificados uma vez, e entradas que não são números de telefone são ignoradas.

namestringopcional

Um nome para a verificação, com até 500 caracteres, como aparece na página Verificação de números. Padrão: API check e a data e a hora em UTC, como API check 2026-10-18 10:40.

curl -X POST https://wbiztool.com/api/v2/number-checks \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: october-leads" \
  -d '{
    "name": "October leads",
    "numbers": ["+919876543210", "+447700900123", "+14155550123"]
  }'

Resposta (201):

{
  "id": 51207,
  "name": "October leads",
  "status": "pending",
  "counts": { "total": 3, "pending": 3, "on_whatsapp": 0, "not_on_whatsapp": 0, "cancelled": 0 },
  "created_at": "2026-10-18T10:40:02.511Z",
  "skipped": 0
}

skipped é quantas entradas não eram um número de telefone (texto, menos de 7 ou mais de 15 dígitos): elas não são verificadas e não contam para o seu plano.

Limites do plano#

O seu plano define quantos números você pode verificar (veja Limites do plano):

  • Por verificação: uma verificação não pode ter mais números que o limite do plano. Acima dele, a verificação é recusada com too_many_numbers, com count e limit.
  • Por período de cobrança: todas as verificações juntas, da API e do painel, também não podem ultrapassá-lo. Uma verificação que ultrapassaria é recusada com number_check_quota_reached, com requested, used e limit.
  • Um plano sem limite não tem nenhum dos dois. A API aceita no máximo 10.000 números por requisição, seja qual for o plano.
  • Uma verificação recusada não coloca nada na fila. Divida a lista, espere o próximo período ou faça upgrade.

Erros ao iniciar uma verificação#

HTTPCódigoQuando
400validation_failednumbers está ausente, vazio ou não é uma lista de strings, ou name está vazio ou é longo demais
403plan_requiredO plano não inclui a verificação de números
422no_valid_numbersNenhuma das entradas é um número de telefone; skipped diz quantas eram
422too_many_numbersMais de 10.000 entradas, ou mais números do que o plano permite por verificação
422number_check_quota_reachedA verificação ultrapassaria os números do plano neste período de cobrança

Listar verificações#

GEThttps://wbiztool.com/api/v2/number-checks

As verificações do espaço de trabalho, da mais recente para a mais antiga, em páginas (limit de 1 a 100, padrão 25, e cursor), incluindo as iniciadas no painel. Cada uma é um Number check.

curl https://wbiztool.com/api/v2/number-checks \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"

Obter uma verificação#

GEThttps://wbiztool.com/api/v2/number-checks/{id}

A verificação e o progresso dela. Consulte-a a cada 30 segundos, mais ou menos, até que status seja completed.

curl https://wbiztool.com/api/v2/number-checks/51207 \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "id": 51207,
  "name": "October leads",
  "status": "processing",
  "counts": { "total": 3, "pending": 1, "on_whatsapp": 1, "not_on_whatsapp": 1, "cancelled": 0 },
  "created_at": "2026-10-18T10:40:02.511Z"
}

Uma verificação que não existe responde 404 number_check_not_found.

A verificação precisa de um número de WhatsApp do espaço de trabalho conectado por código QR ou código de login, e espera enquanto os seus números estão enviando. Uma verificação pode ficar um tempo em pending ou processing; veja Como a verificação funciona.

Obter os resultados#

GEThttps://wbiztool.com/api/v2/number-checks/{id}/results

Os números da verificação e o que foi encontrado, em páginas (limit de 1 a 100, padrão 25, e cursor). Você pode lê-los enquanto a verificação roda: os números ainda não verificados estão em pending.

curl "https://wbiztool.com/api/v2/number-checks/51207/results?limit=100" \
  -H "Authorization: Bearer $WBIZTOOL_API_KEY"
{
  "data": [
    { "number": "14155550123", "on_whatsapp": null, "status": "pending", "checked_at": null },
    { "number": "447700900123", "on_whatsapp": false, "status": "not_on_whatsapp", "checked_at": "2026-10-18T10:42:57.204Z" },
    { "number": "919876543210", "on_whatsapp": true, "status": "on_whatsapp", "checked_at": "2026-10-18T10:42:51.880Z" }
  ],
  "next_cursor": null
}
CampoTipoDescrição
numberstringO número verificado: os dígitos com o código do país, sem +.
on_whatsappboolean or nulltrue ou false depois de verificado; null enquanto pendente ou quando cancelado.
statusstringpending, on_whatsapp, not_on_whatsapp ou cancelled (interrompido antes de ser verificado).
checked_atstring or nullQuando foi verificado.

O objeto Number check#

CampoTipoDescrição
idintegerO id da verificação.
namestringO nome dela.
statusstringpending (nada verificado ainda), processing (alguns verificados) ou completed (nada mais a verificar).
countsobjecttotal, pending, on_whatsapp, not_on_whatsapp e cancelled.
created_atstringQuando foi iniciada.
skippedintegerSó na resposta de Iniciar uma verificação: as entradas que não eram um número de telefone.

Relacionados#