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

API аккаунтов WhatsApp

API списка аккаунтов WhatsApp

Используйте этот API, чтобы одним вызовом получить полный список всех ваших номеров WhatsApp и их статус подключения. В отличие от списка подключённых номеров, он включает и отключённые номера.

POSThttps://wbiztool.com/api/v1/whatsapp/accounts/

Тело запроса: JSON или поля формы

РазличиеСписок аккаунтовСписок подключённых номеров
Включает отключённые и удалённые номераДаНет
Ключи элементовwhatsapp_client_id, whatsapp_number, statusid, whatsapp_client_id, whatsapp_client_number, is_connected
message при успехеОтсутствуетokay

Быстрый пример#

curl -X POST https://wbiztool.com/api/v1/whatsapp/accounts/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY"
  }'

Замените 12345 и YOUR_API_KEY своими значениями. Где их найти, описано в разделе Аутентификация.

Ни в одном из официальных клиентов нет метода для этого endpoint, поэтому вызывайте его напрямую, как в примерах.

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

client_idintegerобязательно

Ваш API Client ID из раздела Настройки → API ключи.

api_keystringобязательно

Ваш API-ключ с той же страницы. Список возвращается для рабочего пространства, в котором создан этот ключ.

Ответ#

Успешный запрос возвращает HTTP 200:

{
  "whatsapp_clients": [
    {
      "whatsapp_client_id": 678,
      "whatsapp_number": "919876543210",
      "status": "connected"
    },
    {
      "whatsapp_client_id": 702,
      "whatsapp_number": "919812345678",
      "status": "not_connected"
    }
  ],
  "status": 1
}
ПолеТипОписание
statusinteger1 при успехе, 0, если запрос не выполнен.
whatsapp_clientsarrayВсе номера WhatsApp, когда-либо добавленные в это рабочее пространство. Присутствует только при успехе.
whatsapp_clients[].whatsapp_client_idintegerID номера. Передавайте его как whatsapp_client в других вызовах API.
whatsapp_clients[].whatsapp_numberstringНомер телефона в том виде, в котором он был сохранён при добавлении.
whatsapp_clients[].statusstringconnected или not_connected.

Порядок элементов в списке не гарантируется. Если порядок важен, сортируйте по whatsapp_client_id.

В успешном ответе нет поля message, поэтому читайте его со значением по умолчанию, как в примерах.

Ошибки#

СообщениеHTTPКак исправить
Auth Error200Передайте client_id и api_key в теле POST-запроса — в виде корректного JSON или полей формы.
Invalid Client Id403Передайте client_id целым числом, например 12345.
Auth Error: invalid api key400Проверьте, что ключ существует, не удалён и принадлежит этому client_id.

Если на сервере возникла непредвиденная проблема или запрос отправлен не методом POST, ответом будет пустой объект: {}. Считайте отсутствие status ошибкой.

Советы#

  • Повторное подключение номера: номер со статусом not_connected можно снова подключить на странице настроек WhatsApp или через API подключения номера.
  • Только один номер: чтобы проверить один номер, используйте Статус подключения.
  • Несколько рабочих пространств: какое рабочее пространство выводится, определяет API-ключ. Используйте ключ, созданный в нужном рабочем пространстве.