Детальный API для массовой проверки номеров WhatsApp

Проверьте, зарегистрирован ли глобальный номер телефона в WhatsApp, и получите подробную информацию о профиле.

URL-адрес API

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

Основные функции

Детальный API (Details API) для массовой проверки номеров WhatsApp предлагает широкие возможности проверки:

Информация об аккаунте

Подробная информация об аккаунте WhatsApp включает:

• Проверку статуса аккаунта
• Подписи пользователей (статусы)
• Временные метки обновления статуса

Массовая обработка

Обрабатывайте множество номеров одновременно путем загрузки файла, что делает массовую проверку эффективной.

Обновление статуса в реальном времени

Отслеживайте выполнение задач массовой проверки с обновлениями статуса в режиме реального времени.

Шаги по использованию

Загрузка файла

Загрузите текстовый файл с номерами телефонов в формате E.164:

Пример запроса

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

Параметры запроса

Проверка статуса

Следите за статусом обработки вашей задачи:

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",
  "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",
  "status": "processing",
  "total": 20000,
  "success": 6724,
  "failure": 0
}

Ответ при завершении задачи

{
  "created_at": "2024-10-19T18:24:56.450567423Z",
  "updated_at": "2024-10-19T18:53:43.141760071Z",
  "task_id": "cs9viu7i61pkfs4oavvg",
  "status": "exported",
  "total": 20000,
  "success": 20000,
  "failure": 0,
  "result_url": "https://example-link-to-results.xlsx"
}

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

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

Коды состояния (Status Codes)

Примечания к интеграции

1. Каждая строка во входном файле должна содержать один номер телефона в формате E.164.
2. Контролируйте статус задачи, используя предоставленный task_id.
3. Загрузите результаты по ссылке result_url, когда статус станет «exported».
4. Обрабатывайте различные коды состояния (status codes) надлежащим образом в вашем приложении.

Часто задаваемые вопросы

1. Какова пропускная способность API?

API может эффективно обрабатывать большие пакеты номеров с обновлениями статуса выполнения в реальном времени.

2. В каком формате должен быть входной файл?

Входной файл должен быть текстовым файлом, в котором каждый номер телефона указан на новой строке в формате E.164 (например, +79123456789).

3. Какую информацию возвращает API?

API возвращает подробную информацию об аккаунте, включая:

• Статус аккаунта WhatsApp
• Подпись (статус) пользователя (например, «Hey there! I am using WhatsApp»)
• Метку времени последнего обновления статуса

4. Какова цена для Детального API?

Цена составляет 2 доллара США за 10 000 номеров для получения подробной информации об аккаунте WhatsApp, включая обновления статуса и подписи.

Для получения дополнительной информации о ценах и больших объемах обработки, пожалуйста, свяжитесь с нами.