API аккаунтов WhatsApp
API списка подключённых номеров WhatsApp
Получите номера WhatsApp вашего рабочего пространства, которые подключены прямо сейчас. Используйте этот API, чтобы пользователи могли выбрать номер для отправки, или чтобы найти ID whatsapp_client для других вызовов API.
https://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"
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/whatsapp-client/list/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
},
timeout=30,
)
result = response.json() # read the body even when the HTTP code is 400 or 403
if result.get("status") == 1:
for number in result["whatsapp_clients"]:
print(number["whatsapp_client_id"], number["whatsapp_client_number"])
else:
print("Failed:", result.get("message"))// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/whatsapp-client/list/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
}),
});
const result = await response.json(); // read the body even when the HTTP code is 400 or 403
if (result.status === 1) {
for (const number of result.whatsapp_clients) {
console.log(number.whatsapp_client_id, number.whatsapp_client_number);
}
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp-client/list/');
curl_setopt_array($ch, [
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => ['Content-Type: application/json'],
CURLOPT_POSTFIELDS => json_encode($payload),
CURLOPT_RETURNTRANSFER => true,
CURLOPT_TIMEOUT => 30,
]);
$result = json_decode(curl_exec($ch), true);
curl_close($ch);
if (($result['status'] ?? 0) === 1) {
foreach ($result['whatsapp_clients'] as $number) {
echo $number['whatsapp_client_id'] . ' ' . $number['whatsapp_client_number'] . PHP_EOL;
}
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}Замените 12345 и YOUR_API_KEY своими значениями. Где их найти, описано в разделе Аутентификация.
Параметры запроса#
client_idintegerобязательноВаш API Client ID из раздела Настройки → API ключи.
api_keystringобязательноВаш API-ключ с той же страницы. Список возвращается для рабочего пространства, в котором создан этот ключ.
Использование официальных клиентов#
Python-клиент вызывает этот endpoint за вас.
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
}
| Поле | Тип | Описание |
|---|---|---|
status | integer | 1 при успехе, 0, если запрос не выполнен. |
message | string | okay при успехе, иначе текст ошибки. |
whatsapp_clients | array | Ваши подключённые номера. Пустой, если ни один номер не подключён. Присутствует только при успехе. |
whatsapp_clients[].whatsapp_client_id | integer | ID номера. Передавайте его как whatsapp_client в других вызовах API. |
whatsapp_clients[].id | integer | То же значение, что и whatsapp_client_id. |
whatsapp_clients[].whatsapp_client_number | string | Номер телефона в том виде, в котором он был сохранён при добавлении номера. |
whatsapp_clients[].is_connected | boolean | Всегда true, так как в список попадают только подключённые номера. |
Порядок списка не гарантируется. Если порядок важен, сортируйте по whatsapp_client_id.
Ошибки#
| Сообщение | HTTP | Как исправить |
|---|---|---|
Auth Error | 200 | Передайте client_id и api_key в теле POST-запроса — в виде корректного JSON или полей формы. |
Invalid Client Id | 403 | Передайте client_id целым числом, например 12345. |
Auth Error: invalid api key | 400 | Проверьте, что ключ существует, не удалён и принадлежит этому client_id. |
Запрос, отправленный не методом POST, возвращает пустой объект {}. При непредвиденной проблеме на сервере возвращается HTTP 500 с HTML-телом, поэтому проверяйте, что ответ — JSON, прежде чем читать status.
Советы#
- Пустой список:
"whatsapp_clients": []означает, что в этом рабочем пространстве нет подключённых номеров. Подключите номер на странице настроек WhatsApp или через API подключения номера. - Несколько рабочих пространств: какое рабочее пространство выводится, определяет API-ключ. Используйте ключ, созданный в нужном рабочем пространстве.
- Только один номер: чтобы проверить один номер, используйте Статус подключения.
