API аккаунтов WhatsApp
API списка аккаунтов WhatsApp
Используйте этот API, чтобы одним вызовом получить полный список всех ваших номеров WhatsApp и их статус подключения. В отличие от списка подключённых номеров, он включает и отключённые номера.
https://wbiztool.com/api/v1/whatsapp/accounts/Тело запроса: JSON или поля формы
| Различие | Список аккаунтов | Список подключённых номеров |
|---|---|---|
| Включает отключённые и удалённые номера | Да | Нет |
| Ключи элементов | whatsapp_client_id, whatsapp_number, status | id, 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"
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/whatsapp/accounts/",
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 account in result["whatsapp_clients"]:
print(account["whatsapp_client_id"], account["whatsapp_number"], account["status"])
else:
print("Failed:", result.get("message", "no response"))// Node.js 18+ (built-in fetch). Save as .mjs to use top-level await.
const response = await fetch("https://wbiztool.com/api/v1/whatsapp/accounts/", {
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 account of result.whatsapp_clients) {
console.log(account.whatsapp_client_id, account.whatsapp_number, account.status);
}
} else {
console.error("Failed:", result.message ?? "no response");
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp/accounts/');
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 $account) {
echo $account['whatsapp_client_id'] . ' ' . $account['whatsapp_number'] . ' ' . $account['status'] . PHP_EOL;
}
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}Замените 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
}
| Поле | Тип | Описание |
|---|---|---|
status | integer | 1 при успехе, 0, если запрос не выполнен. |
whatsapp_clients | array | Все номера WhatsApp, когда-либо добавленные в это рабочее пространство. Присутствует только при успехе. |
whatsapp_clients[].whatsapp_client_id | integer | ID номера. Передавайте его как whatsapp_client в других вызовах API. |
whatsapp_clients[].whatsapp_number | string | Номер телефона в том виде, в котором он был сохранён при добавлении. |
whatsapp_clients[].status | string | connected или not_connected. |
Порядок элементов в списке не гарантируется. Если порядок важен, сортируйте по whatsapp_client_id.
В успешном ответе нет поля message, поэтому читайте его со значением по умолчанию, как в примерах.
Ошибки#
| Сообщение | 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, ответом будет пустой объект: {}. Считайте отсутствие status ошибкой.
Советы#
- Повторное подключение номера: номер со статусом
not_connectedможно снова подключить на странице настроек WhatsApp или через API подключения номера. - Только один номер: чтобы проверить один номер, используйте Статус подключения.
- Несколько рабочих пространств: какое рабочее пространство выводится, определяет API-ключ. Используйте ключ, созданный в нужном рабочем пространстве.
