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

API проверки RCS: быстрая проверка номеров телефонов

Проверьте детали RCS введенных глобальных номеров телефонов, поддерживают ли они обмен сообщениями RCS

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

Окно терминала
curl --location 'https://api.checknumber.ai/v1/tasks' \
--header 'X-API-Key: API-KEY' \
--form 'file=@"./number.txt"' \
--form 'task_type="rcs"'

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

Окно терминала
curl --location 'https://api.checknumber.ai/v1/gettasks' \
--header 'X-API-Key: API-KEY' \
--form 'task_id="task_id"'

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

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

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

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

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

{
"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...",
"actual_amount": {
"amount": "2.000000",
"currency": "USD"
}
}

URL запроса загрузки файла

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

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

ПараметрОписание
filefile, загрузите файл; каждая строка должна содержать один номер в формате E.164
task_typestring, тип задачи, установите rcs

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

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

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

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

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

ПолеОписаниеПример
NumberНомер телефона в формате E.164+12025551234
rcsИмеет ли номер включенный RCSyes, no

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

ПолеОписание
created_atВременная метка создания задачи
updated_atВременная метка последнего обновления задачи
task_idУникальный идентификатор задачи
user_idID пользователя
statusСтатус задачи:
pending: в очереди
processing: обработка
exported: результаты доступны для скачивания
failed: задача завершилась с ошибкой, списанная сумма автоматически возвращается
totalВсего обработано номеров телефонов
successНомера успешно идентифицированы
failureНомера с ошибкой обработки
result_url(Опционально) URL для скачивания результатов при статусе exported
actual_amount(Необязательно) Фактически списанная сумма, возвращается после завершения расчёта по задаче
estimated_amount(Ответ при создании) Ориентировочная стоимость задачи; окончательное списание происходит после её завершения

Коды статуса

СтатусОписание
200free, запрос успешно выполнен (например, запрос статуса)
202charge, задача успешно создана; списывается ориентировочная сумма
400free, неверный запрос: недопустимые параметры или формат файла, неподдерживаемый тип задачи или количество корректных записей меньше минимального
401free, отсутствует или недействителен API-ключ
402free, недостаточно средств на балансе
404free, задача не найдена
413free, загруженный файл слишком большой
500free, внутренняя ошибка сервера, повторите попытку позже