Перейти к содержимому

Telegram Username Full API: пакетная проверка

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

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

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

@example_user
@another_user

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

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="tg_username_full"'

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

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

ПолеОписаниеПример
usernameИмя пользователя из переданного файла.example_user
activatedПоказывает, был ли вход активным или зарегистрированным.yes
nicknameВозвращаемое поле результата: nickname.пример значения
avatarВозвращаемое поле результата: avatar.пример значения
genderВозвращаемое поле результата: gender.пример значения
ageВозвращаемое поле результата: age.пример значения
skin_colorВозвращаемое поле результата: skin_color.пример значения
user_idВозвращаемое поле результата: user_id.пример значения
active_daysВозвращаемое поле результата: active_days.пример значения
is_vipВозвращаемое поле результата: is_vip.пример значения
is_frozenВозвращаемое поле результата: is_frozen.пример значения

Note: Verified against live sample; full profile, activity, VIP, and frozen fields are now confirmed.

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

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

Поля ответа

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

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

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

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

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