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

API аккаунтов WhatsApp

API статуса подключения WhatsApp

Проверьте, подключён ли один из ваших номеров WhatsApp и готов ли он к отправке сообщений. Используйте его перед кампанией или в ожидании, пока завершится привязка нового подключаемого номера. Используйте этот endpoint, а не /api/v1/whatsapp/status/<id>/, который не работает.

POSThttps://wbiztool.com/api/v1/whatsapp-client/status/

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

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

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

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

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

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

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

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

Ваш API-ключ с той же страницы.

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

ID проверяемого номера WhatsApp со страницы настроек WhatsApp, из списка аккаунтов или whatsapp_client_id, возвращённый API подключения номера.

Использование официальных клиентов#

Python-клиент вызывает этот endpoint за вас.

Python
from wbiztool_client import WbizToolClient

client = WbizToolClient(api_key="YOUR_API_KEY", client_id=12345)

result = client.get_whatsapp_client_status(678)
print(result)

Python-клиент выбрасывает requests.exceptions.HTTPError, когда API возвращает HTTP 400 или 403, поэтому оберните вызов в try/except.

getWhatsAppClientStatus() в клиенте Node.js обращается к несуществующему адресу и завершается ошибкой 404. Используйте fetch, как в быстром примере.

Ответ#

При действительных учётных данных запрос возвращает HTTP 200 с одним из этих тел ответа.

Номер подключён:

{ "message": "Connected", "status": 1 }

Номер не подключён:

{ "message": "Disconnected", "status": 0 }
ПолеТипОписание
statusinteger1, если номер подключён. 0, если он не подключён или запрос не выполнен.
messagestringConnected, Disconnected или текст ошибки.

Для номера, удалённого на странице настроек WhatsApp, тоже возвращается Disconnected.

Ошибки#

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

Советы#

  • Перед отправкой: если номер, с которого вы отправляете, отключён, его сообщения ждут в очереди, пока он не подключится снова или не истечёт их срок, поэтому проверяйте статус перед крупными рассылками. Неотправленные сообщения на отключённом номере удаляются через 90 дней.
  • После подключения номера: опрашивайте этот endpoint каждые несколько секунд, пока он не вернёт Connected. Webhook connected может прийти на несколько секунд раньше, чем этот endpoint вернёт Connected, поэтому продолжайте опрос до минуты после события. См. API подключения номера.
  • Все номера сразу: чтобы получить статус всех номеров одним вызовом, используйте список аккаунтов.