Pular para o conteúdo

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

Verifique os detalhes do WhatsApp do número global de entrada, se é uma conta WhatsApp

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

curl --location 'https://api.ekycpro.com/wa/api/simple/tasks' \
--header 'X-API-Key: API-KEY' \
--form 'user_id="USER_ID"' \
--form 'file=@"input.txt"'

Exemplo de código para verificar o status da tarefa:

curl --location 'https://api.ekycpro.com/wa/api/simple/tasks/cs9viu7i61pkfs4oavvg?user_id=USER_ID' \
--header 'X-API-Key: API-KEY'

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

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

Resposta para o 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 foi concluída e incluindo a 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"
}

URL de solicitação para upload de arquivo

POST https://api.ekycpro.com/wa/api/simple/tasks

Parâmetros de solicitação para upload de arquivo

ParâmetroDescrição
user_idstring, ID do usuário
filefile, Arquivo para upload, cada linha deve conter um número de telefone no formato E.164

URL de solicitação para verificar status da tarefa

GET https://api.ekycpro.com/wa/api/simple/tasks/{TASK_ID}

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

ParâmetroDescrição
user_idstring, ID do usuário

Campos do Resultado

CampoDescriçãoExemplo
NumberNúmero de telefone no formato E.164+41798284651
whatsappSe o número tem uma conta WhatsApp ativasim, não

Formato da Resposta

CampoDescrição
created_atTimestamp de criação da tarefa
updated_atTimestamp da última atualização do status da tarefa
task_idIdentificador único da tarefa
user_idID do usuário
statusStatus da tarefa:
pending: Na fila e aguardando
processing: Em processamento
completed: Processamento concluído
exported: Resultados disponíveis para download
totalTotal de números de telefone processados
successNúmeros identificados com sucesso
failureNúmeros que falharam no processamento
result_url(Opcional) URL de download dos resultados quando o status é exported

Códigos de Status

StatusDescrição
200charge, Solicitação bem-sucedida, tarefa criada ou status recuperado
400free, Requisição inválida, parâmetros ou formato de arquivo inválidos
500free, Erro interno do servidor, tente novamente mais tarde