Pular para o conteúdo

Advanced US Carrier API: Verificação em lote

Advanced US Carrier: Processe os valores de entrada pela API em lote e obtenha os campos de resultado listados abaixo.

Formato de entrada

Envie um arquivo de texto com um número de telefone por linha. Normalize os valores antes do upload; o formato E.164 é recomendado para telefones.

+14155552671
+442071838750

Criar uma tarefa

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

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

A API retorna um ID de tarefa. Guarde esse ID e use-o para consultar o status.

Resposta do upload

{
"task_id": "d4g8o46p2jvh04o9uolg",
"status": "pending",
"total": 5000,
"estimated_amount": {
"amount": "0.500000",
"currency": "USD"
},
"message": "Task created successfully"
}

Verificar status da tarefa

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

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

Consulte até que status se torne exported. Não trate pending ou processing como resultado concluído.

Resposta em processamento

{
"task_id": "d4g8o46p2jvh04o9uolg",
"status": "processing",
"total": 5000,
"success": 2500,
"failure": 0
}

Resposta exportada

{
"task_id": "d4g8o46p2jvh04o9uolg",
"status": "exported",
"total": 5000,
"success": 5000,
"failure": 0,
"result_url": "https://example-link-to-results.zip",
"actual_amount": {
"amount": "2.000000",
"currency": "USD"
}
}

Campos do resultado

CampoDescriçãoExemplo
NumberNúmero de telefone do arquivo enviado.+14155552671
number_typeTipo de linha retornado para o número.mobile
carrierCarrier value returned for the number.Exemplo Carrier
cityCidade retornada pelo serviço para a entrada.valor de exemplo

Note: Live sample currently contains Number, number_type, carrier, and city only.

Tratamento do arquivo de resultado

Baixe o arquivo por result_url somente após a tarefa ser exportada. Preserve os nomes das colunas retornados ao processar o arquivo.

Campos da resposta

CampoDescrição
created_atData e hora de criação da tarefa.
updated_atData e hora da última atualização de status.
task_idIdentificador exclusivo da tarefa.
statuspending, processing, exported ou failed.
totalTotal de valores de entrada processados.
successValores processados com sucesso.
failureValores cujo processamento falhou.
result_urlURL de download quando a tarefa é exportada.
actual_amountValor final liquidado, quando disponível.
estimated_amountValor estimado retornado ao criar a tarefa.

Códigos de status

StatusDescrição
200Solicitação bem-sucedida.
202Tarefa criada com sucesso e cobrança estimada aplicada.
400Arquivo inválido, tipo de tarefa não compatível ou poucas entradas válidas.
401Chave de API ausente ou inválida.
402Saldo insuficiente.
404Tarefa não encontrada.
413O arquivo enviado é grande demais.
500Erro interno do servidor; tente novamente mais tarde.

Observações operacionais

  • A tarefa é assíncrona; use o ID da tarefa para consultar o status.
  • Verifique os limites de entrada do produto antes do upload.
  • As linhas com falha aparecem no resultado exportado e são refletidas nos contadores.
  • Os campos acima são baseados no sample atual e podem mudar quando o esquema de exportação upstream mudar.