Telegram API массовой проверки номеров: быстрая проверка

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

Пример загрузки файла:

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

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

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

Ответ при успешной загрузке файла:

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

Ответ для статуса обработки:

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

Ответ при завершении задачи (включает URL скачивания результата):

{
  "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 запроса загрузки файла

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

Параметры запроса загрузки файла

Параметр	Описание
file	file, Загрузите файл; каждая строка должна содержать номер в формате E.164
task_type	string, Тип задачи, установите “tg”

URL запроса проверки статуса

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

Параметры запроса проверки статуса

Параметр	Описание
task_id	string, ID задачи, возвращаемый при создании

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

Поле	Описание	Пример
Number	Номер телефона в формате E.164	+41798284651
telegram	Есть ли у номера активная учетная запись Telegram	yes, no

Формат ответа

Поле	Описание
created_at	Время создания задачи
updated_at	Время последнего обновления статуса задачи
task_id	Уникальный идентификатор задачи
user_id	Идентификатор пользователя
status	Статус задачи: pending: в очереди и ожидает обработки processing: обрабатывается exported: результаты доступны для скачивания
total	Всего обработано номеров телефонов
success	Номера успешно определены
failure	Номера, которые не удалось обработать
result_url	Необязательно: URL для скачивания результатов при статусе exported

Коды статуса

Статус	Описание
200	charge, запрос успешно выполнен, задача создана или получен ее статус
400	free, неверный запрос, недопустимые параметры или формат файла
500	free, внутренняя ошибка сервера, повторите попытку позже