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

Начало работы

Начало работы с API Wbiztool

REST API Wbiztool позволяет вашему программному обеспечению отправлять сообщения WhatsApp с вашего собственного подключённого номера WhatsApp. Отправляйте статусы заказов, напоминания и уведомления из своего приложения, CRM, сайта или инструмента автоматизации.

На этой странице описано то, что нужно для любого запроса. Чтобы отправить первое сообщение, перейдите к разделу Отправка сообщения.

Базовый URL#

Все endpoint находятся по адресу:

https://wbiztool.com/api/v1/

Большинство endpoint принимают запросы POST. Тело запроса можно передавать как JSON (application/json) или как поля формы (application/x-www-form-urlencoded). Для загрузки файла используйте multipart/form-data. Некоторые endpoint для чтения данных используют GET; метод указан на странице каждого endpoint.

Перед началом работы#

  1. Создайте аккаунт на wbiztool.com/signup. Новые аккаунты получают 50 бесплатных сообщений.
  2. Подключите номер WhatsApp. Откройте настройки WhatsApp, нажмите кнопку подключения и отсканируйте QR-код в WhatsApp на телефоне.
  3. Создайте API-ключ. Перейдите в раздел Настройки → API ключи. Создавать ключи может только владелец рабочего пространства. В каждом рабочем пространстве может быть до 10 ключей.

Аутентификация#

Большинство endpoint принимают учётные данные в теле каждого запроса. API проверки номеров вместо этого использует заголовок Authorization: Bearer; подробности — на его страницах.

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

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

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

Один из ваших API-ключей с той же страницы. Храните его в секрете: любой, у кого есть ключ, может отправлять сообщения с ваших номеров.

whatsapp_clientintegerБольшинство endpoint для сообщений

ID номера WhatsApp, с которого отправляются сообщения, указанный в столбце ID клиента WhatsApp на странице настроек WhatsApp. На странице каждого endpoint указано, нужен ли он.

API-ключ определяет, с каким рабочим пространством работает запрос. Если вы состоите в нескольких рабочих пространствах, используйте ключ, созданный в том пространстве, от имени которого хотите отправлять сообщения.

Если ключ стал известен посторонним, удалите его на странице API-ключей. Удалённые ключи перестают работать сразу.

Ваш первый запрос#

Этот запрос отправляет текстовое сообщение с вашего подключённого номера. Замените ID, ключ и номер телефона своими значениями.

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

Ответ "status": 1 с msg_id означает, что сообщение поставлено в очередь. На странице Отправка сообщения описаны все параметры и есть версии на Python, Node.js и PHP.

Ответы и ошибки#

Каждый ответ — JSON-объект с полем status (кроме проверки доступности /api/v1/status/, которая возвращает "status": 200):

  • "status": 1 означает, что запрос выполнен успешно.
  • "status": 0 означает, что запрос не выполнен. Причина указана в поле message.
{ "status": 0, "message": "Auth Error: invalid api key" }

Частые ошибки аутентификации:

СообщениеЗначение
Auth ErrorОтсутствует client_id или api_key, тело запроса не является корректным JSON или данными формы, либо запрос отправлен не методом POST.
Auth Error - Please send correct API key and Client idapi_key отсутствует или пустой.
Invalid client id. или Invalid Client Idclient_id не является целым числом (или, в некоторых endpoint, отсутствует). Передавайте его числом, например 12345.
Auth Error: invalid api keyКлюч не существует, удалён или не принадлежит этому client_id.
Demo Account can not access apisДемо-аккаунты не могут использовать API.
Not enough creditsВ вашем тарифе закончились сообщения. Повысьте тариф или дождитесь следующего расчётного периода.

Жизненный цикл сообщения#

Сообщения, отправленные через API, сначала ставятся в очередь, а затем отправляются с вашего номера WhatsApp. У каждого сообщения один из следующих статусов:

СтатусНазваниеЗначение
0CreatedВ очереди, ожидает отправки.
1SentОтправлено с вашего номера WhatsApp.
2FailedНе удалось отправить, например потому что номера нет в WhatsApp.
3CancelledОтменено до отправки.
4ExpiredНе отправлено до истечения срока expire_after_seconds.

Чтобы сообщения из очереди уходили, ваш номер WhatsApp должен оставаться подключённым. Если номер, с которого вы отправляете, отключён, его сообщения ждут в очереди, пока номер не подключится снова или не истечёт их срок. Неотправленные сообщения отключённого номера удаляются через 90 дней.

Чтобы отслеживать сообщение, сохраните msg_id из ответа и либо передайте URL в webhook при отправке, либо вызовите API статуса сообщений.

Официальные клиентские библиотеки#

Обёртки для Python и Node.js берут на себя аутентификацию и загрузку файлов. Пока они корректно поддерживают не все endpoint, поэтому прежде чем полагаться на метод клиента, проверьте страницу соответствующего endpoint.

pip install wbiztool-client

Предпочитаете no-code? В разделе Приложения и интеграции описаны Zapier, n8n, Make, Pabbly Connect, Google Sheets, Shopify и WordPress.

Обзор документации#