API de Verificação em Massa do WhatsApp: Verificação Rápida de Números

Verifique os detalhes do WhatsApp do número global inserido, se é uma conta do WhatsApp. Serviço baseado em cache de curto prazo e detecção em tempo real.

Exemplo de código para enviar arquivo de detecção:

curl --location 'https://api.checknumber.ai/v1/tasks' \
--header 'X-API-Key: API-KEY' \
--form 'file=@"./number.txt"' \
--form 'task_type="ws"'

Exemplo de código para verificar status da tarefa:

curl --location 'https://api.checknumber.ai/v1/gettasks' \
--header 'X-API-Key: API-KEY' \
--form 'task_id="task_id"'

Resposta para envio bem-sucedido do arquivo de detecção

{
  "task_id": "cs9viu7i61pkfs4oavvg",
  "status": "pending",
  "total": 20000,
  "estimated_amount": {
    "amount": "2.000000",
    "currency": "USD"
  },
  "message": "Task created successfully. Numbers are being validated and processed in the background.",
  "created_at": "2024-10-19T18:24:56.450567423Z"
}

Resposta para status de processamento

{
  "created_at": "2024-10-19T18:24:56.450567423Z",
  "updated_at": "2024-10-19T18:33:22.86152082Z",
  "task_id": "cs9viu7i61pkfs4oavvg",
  "user_id": "test",
  "status": "processing",
  "total": 20000,
  "success": 6724,
  "failure": 0
}

Resposta indicando que a tarefa está concluída e inclui o URL de download dos resultados

{
  "created_at": "2024-10-19T18:24:56.450567423Z",
  "updated_at": "2024-10-19T18:53:43.141760071Z",
  "task_id": "cs9viu7i61pkfs4oavvg",
  "user_id": "test",
  "status": "exported",
  "total": 20000,
  "success": 20000,
  "failure": 0,
  "result_url": "https://example-link-to-results.xlsx",
  "actual_amount": {
    "amount": "2.000000",
    "currency": "USD"
  }
}

URL de solicitação para enviar arquivo

POST https://api.checknumber.ai/v1/tasks

Parâmetros de solicitação para enviar arquivo

Parâmetro	Descrição
file	file, Arquivo de upload, cada linha deve conter um número de telefone no formato E.164
task_type	string, Tipo de tarefa, definir como “ws”

URL de solicitação para verificar status da tarefa

POST https://api.checknumber.ai/v1/gettasks

Parâmetros de solicitação para verificar status da tarefa

Parâmetro	Descrição
task_id	string, ID da tarefa retornado da criação da tarefa

Campos de resultado

Campo	Descrição	Exemplo
Number	Número de telefone no formato E.164	+41798284651
whatsapp	Se o número tem uma conta WhatsApp ativa	yes, no

Formato de resposta

Campo	Descrição
created_at	Timestamp de quando a tarefa foi criada
updated_at	Timestamp da última atualização do status da tarefa
task_id	Identificador único da tarefa
user_id	ID do usuário
status	Status da tarefa: pending: Na fila e aguardando processing: Atualmente processando exported: Resultados disponíveis para download failed: A tarefa falhou, o valor cobrado é reembolsado automaticamente
total	Total de números de telefone processados
success	Números identificados com sucesso
failure	Números que falharam no processamento
result_url	(Opcional) URL de download dos resultados quando o status é exported
actual_amount	(Opcional) Valor efetivamente cobrado, disponível após a liquidação da tarefa
estimated_amount	(Resposta de criação) Valor estimado da tarefa; a cobrança final é liquidada na conclusão

Códigos de status

Status	Descrição
200	free, Solicitação bem-sucedida (ex.: consulta de status)
202	charge, Tarefa criada com sucesso; o valor estimado é deduzido
400	free, Solicitação inválida: parâmetros ou formato de arquivo inválidos, tipo de tarefa não suportado ou entradas válidas abaixo do lote mínimo
401	free, Chave de API ausente ou inválida
402	free, Saldo insuficiente
404	free, Tarefa não encontrada
413	free, Arquivo enviado muito grande
500	free, Erro interno do servidor, tente novamente mais tarde