API Массовой Проверки WhatsApp: Быстрая Проверка Номеров

Проверьте детали WhatsApp введенного глобального номера, является ли это аккаунтом WhatsApp. Сервис на основе краткосрочного кэша и обнаружения в реальном времени.

Пример кода для загрузки файла обнаружения:

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

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

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`, Тип задачи, установите “ws”

URL запроса для проверки статуса задачи

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

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

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

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

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

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

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

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

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