Pular para o conteúdo

API de verificação rápida de números de telefone para RCS

Verifique os detalhes de RCS dos números de telefone globais inseridos, se eles suportam mensagens RCS

Exemplo para enviar o arquivo de detecção:

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

Exemplo para consultar o status da tarefa:

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

Resposta para upload bem-sucedido

{
"task_id": "d4g8o46p2jvh04o9uolg",
"status": "pending",
"total": 2049,
"message": "Task created successfully",
"created_at": "2025-11-21T15:58:08.916446594Z"
}

Resposta para status de processamento

{
"created_at": "2025-11-21T08:27:09.933Z",
"updated_at": "2025-11-21T08:27:10.241Z",
"task_id": "d4g24nep2jvh04o9uoh0",
"user_id": "wfi7wGPS4B4PdtTMox5Y",
"status": "processing",
"total": 2049,
"success": 1024,
"failure": 0
}

Resposta quando a tarefa for concluída (inclui a URL de download):

{
"created_at": "2025-11-21T08:27:09.933Z",
"updated_at": "2025-11-21T08:27:10.241Z",
"task_id": "d4g24nep2jvh04o9uoh0",
"user_id": "wfi7wGPS4B4PdtTMox5Y",
"status": "exported",
"total": 2049,
"success": 2049,
"failure": 0,
"result_url": "https://wapic.s3.ap-southeast-1.amazonaws.com/externalcheck/d4g24nep2jvh04o9uoh0/d4g24nep2jvh04o9uoh0.zip?X-Amz-Algorithm=AWS4-HMAC-SHA256..."
}

URL da requisição para upload de arquivo

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

Parâmetros da requisição para upload de arquivo

ParâmetroDescrição
filefile, Envie um arquivo; cada linha deve conter um número de telefone no formato E.164
task_typestring, Tipo de tarefa, defina como “rcs”

URL da requisição para consultar status

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

Parâmetros da requisição para consultar status

ParâmetroDescrição
task_idstring, ID da tarefa retornado na criação

Campos do resultado

CampoDescriçãoExemplo
NumberNúmero de telefone em formato E.164+12025551234
rcsSe o número tem RCS ativadoyes, no

Formato da resposta

CampoDescrição
created_atTimestamp quando a tarefa foi criada
updated_atTimestamp da última atualização de status da tarefa
task_idIdentificador único da tarefa
user_idID do usuário
statusStatus da tarefa:
pending: Na fila aguardando
processing: Processando
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 para 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