WhatsAppアカウントAPI
接続ステータスAPI
WhatsApp番号のいずれかが接続されていて、メッセージを送信できる状態かどうかを確認します。キャンペーンの前や、新しく接続した番号のリンク完了を待つ間に使用します。/api/v1/whatsapp/status/<id>/は機能しないため、代わりにこのエンドポイントを使用してください。
POST
https://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
}'import requests
response = requests.post(
"https://wbiztool.com/api/v1/whatsapp-client/status/",
json={
"client_id": 12345,
"api_key": "YOUR_API_KEY",
"whatsapp_client": 678,
},
timeout=30,
)
result = response.json() # read the body even when the HTTP code is 400 or 403
if result["status"] == 1:
print("Connected")
elif result["message"] == "Disconnected":
print("Not connected. Reconnect it in WhatsApp settings.")
else:
print("Failed:", result["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/status/", {
method: "POST",
headers: { "Content-Type": "application/json" },
body: JSON.stringify({
client_id: 12345,
api_key: "YOUR_API_KEY",
whatsapp_client: 678,
}),
});
const result = await response.json(); // read the body even when the HTTP code is 400 or 403
if (result.status === 1) {
console.log("Connected");
} else if (result.message === "Disconnected") {
console.log("Not connected. Reconnect it in WhatsApp settings.");
} else {
console.error("Failed:", result.message);
}<?php
$payload = [
'client_id' => 12345,
'api_key' => 'YOUR_API_KEY',
'whatsapp_client' => 678,
];
$ch = curl_init('https://wbiztool.com/api/v1/whatsapp-client/status/');
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) {
echo 'Connected';
} elseif (($result['message'] ?? '') === 'Disconnected') {
echo 'Not connected. Reconnect it in WhatsApp settings.';
} else {
echo 'Failed: ' . ($result['message'] ?? 'no response');
}12345、YOUR_API_KEY、678はご自身の値に置き換えてください。値の確認場所は認証をご覧ください。
リクエストパラメータ#
client_idinteger必須設定 → APIキーに表示されるAPIクライアントIDです。
api_keystring必須同じページにあるAPIキーです。
whatsapp_clientinteger必須確認するWhatsApp番号のIDです。WhatsApp設定、アカウント一覧、または番号の接続で返された
whatsapp_client_idから取得できます。
公式クライアントを使う#
Pythonクライアントは、このエンドポイントを代わりに呼び出します。
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クライアントは、APIがHTTP 400または403を返すとrequests.exceptions.HTTPErrorを発生させるため、呼び出しをtry/exceptで囲んでください。
Node.jsクライアントのgetWhatsAppClientStatus()は存在しないアドレスを呼び出し、404で失敗します。クイック例のようにfetchを使ってください。
レスポンス#
認証情報が有効な場合、リクエストはHTTP 200で次のいずれかのボディを返します。
番号が接続されている場合:
{ "message": "Connected", "status": 1 }
番号が接続されていない場合:
{ "message": "Disconnected", "status": 0 }
| フィールド | 型 | 説明 |
|---|---|---|
status | integer | 番号が接続されている場合は1。接続されていない場合、またはリクエストが失敗した場合は0。 |
message | string | Connected、Disconnected、またはエラー内容。 |
WhatsApp設定から削除した番号でもDisconnectedが返ります。
エラー#
| メッセージ | HTTP | 対処方法 |
|---|---|---|
Auth Error | 200 | client_id、api_key、数値のwhatsapp_clientを、有効なJSONまたはフォームフィールドとしてPOSTボディで送信してください。 |
Invalid Client Id | 403 | client_idは12345のような整数で送信してください。 |
Auth Error: invalid api key | 400 | キーが存在し、削除されておらず、このclient_idに属していることを確認してください。 |
Auth Error 2 | 200 | そのwhatsapp_client IDはこのAPIキーのワークスペースにありません。 |
Demo Account can not access apis | 200 | 通常のアカウントを使用してください。 |
ヒント#
- 送信前に確認する:送信に使う番号の接続が切れている場合、そのメッセージは再接続されるか期限切れになるまでキューで待機します。大量に送信する前にステータスを確認してください。切断された番号の未送信メッセージは、90日後に削除されます。
- 番号を接続した後:
Connectedが返るまで、数秒ごとにこのエンドポイントをポーリングしてください。connectedWebhookは、このエンドポイントがConnectedを返す数秒前に届くことがあるため、イベントの後も最大1分間ポーリングを続けてください。番号の接続を参照してください。 - すべての番号をまとめて確認する:1回の呼び出しですべての番号のステータスを取得するには、アカウント一覧を使用してください。
