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

API аккаунтов WhatsApp

API списка подключённых номеров WhatsApp

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

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

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

Возвращаются только подключённые номера. Чтобы увидеть и отключённые номера, используйте список аккаунтов.

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

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

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

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

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

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

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

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

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

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

Python
from wbiztool_client import WbizToolClient

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

result = client.list_whatsapp_clients()
for number in result.get("whatsapp_clients", []):
    print(number["whatsapp_client_id"], number["whatsapp_client_number"])

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

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

Ответ#

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

{
  "message": "okay",
  "whatsapp_clients": [
    {
      "id": 678,
      "whatsapp_client_id": 678,
      "whatsapp_client_number": "919876543210",
      "is_connected": true
    }
  ],
  "status": 1
}
ПолеТипОписание
statusinteger1 при успехе, 0, если запрос не выполнен.
messagestringokay при успехе, иначе текст ошибки.
whatsapp_clientsarrayВаши подключённые номера. Пустой, если ни один номер не подключён. Присутствует только при успехе.
whatsapp_clients[].whatsapp_client_idintegerID номера. Передавайте его как whatsapp_client в других вызовах API.
whatsapp_clients[].idintegerТо же значение, что и whatsapp_client_id.
whatsapp_clients[].whatsapp_client_numberstringНомер телефона в том виде, в котором он был сохранён при добавлении номера.
whatsapp_clients[].is_connectedbooleanВсегда true, так как в список попадают только подключённые номера.

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

Ошибки#

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

Запрос, отправленный не методом POST, возвращает пустой объект {}. При непредвиденной проблеме на сервере возвращается HTTP 500 с HTML-телом, поэтому проверяйте, что ответ — JSON, прежде чем читать status.

Советы#

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