Advanced US Carrier API: пакетная проверка

Advanced US Carrier: Обрабатывайте входные значения через пакетный API и получайте перечисленные ниже поля результата.

Формат входных данных

Загрузите текстовый файл, по одному номеру телефона в строке. Нормализуйте значения перед загрузкой; для телефонов рекомендуется формат E.164.

+14155552671
+442071838750

Создание задачи

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

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

API возвращает ID задачи. Сохраните его и используйте для проверки статуса.

Ответ при загрузке

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

Проверка статуса задачи

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

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

Проверяйте статус, пока status не станет exported. Значения pending и processing не означают завершение.

Ответ при обработке

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

Экспортированный ответ

{
  "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"
  }
}

Поля результата

Поле	Описание	Пример
Number	Номер телефона из переданного файла.	+14155552671
number_type	Тип линии, возвращаемый для номера.	mobile
carrier	Carrier value returned for the number.	Пример Carrier
city	Город, возвращённый сервисом для входного значения.	пример значения

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

Обработка файла результата

Скачивайте файл по result_url только после экспорта задачи. Сохраняйте имена возвращённых столбцов при дальнейшей обработке.

Поля ответа

Поле	Описание
created_at	Время создания задачи.
updated_at	Время последнего обновления статуса.
task_id	Уникальный идентификатор задачи.
status	pending, processing, exported или failed.
total	Общее число обработанных входных значений.
success	Успешно обработанные значения.
failure	Значения, обработка которых завершилась ошибкой.
result_url	URL для скачивания после экспорта задачи.
actual_amount	Итоговая сумма, если доступна.
estimated_amount	Расчётная сумма, возвращаемая при создании задачи.

Коды состояния

Status	Описание
200	Запрос выполнен успешно.
202	Задача создана успешно, применена предварительная стоимость.
400	Недопустимый файл, неподдерживаемый тип задачи или слишком мало корректных записей.
401	API-ключ отсутствует или недействителен.
402	Недостаточно средств на счёте.
404	Задача не найдена.
413	Загруженный файл слишком велик.
500	Внутренняя ошибка сервера; повторите попытку позже.

Рабочие примечания

• Задача выполняется асинхронно; используйте ID задачи для проверки статуса.
• Перед загрузкой проверьте ограничения продукта на входные данные.
• Ошибочные строки указаны в экспортированном результате и отражены в счётчиках задачи.
• Поля выше основаны на текущем live sample и могут измениться при изменении схемы экспорта.