WhatsAppアカウントAPI
WhatsAppアカウント一覧API
このAPIを使うと、すべてのWhatsApp番号とその接続状態の完全な一覧を1回の呼び出しで取得できます。接続済み番号の一覧とは異なり、接続が切れている番号も含まれます。
POST
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はご自身の値に置き換えてください。値の確認場所は認証をご覧ください。
どちらの公式クライアントにもこのエンドポイント用のメソッドはないため、例のように直接呼び出してください。
リクエストパラメータ#
client_idinteger必須設定 → APIキーに表示されるAPIクライアントIDです。
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。ほかのAPI呼び出しでwhatsapp_clientとして指定します。 |
whatsapp_clients[].whatsapp_number | string | 追加時に保存された電話番号。 |
whatsapp_clients[].status | string | connectedまたはnot_connected。 |
一覧の並び順は保証されていません。順序が重要な場合はwhatsapp_client_idで並べ替えてください。
成功時のレスポンスにはmessageフィールドがないため、例のようにフォールバックを用意して読み取ってください。
エラー#
| メッセージ | HTTP | 対処方法 |
|---|---|---|
Auth Error | 200 | client_idとapi_keyの両方を、有効なJSONまたはフォームフィールドとしてPOSTボディで送信してください。 |
Invalid Client Id | 403 | client_idは12345のような整数で送信してください。 |
Auth Error: invalid api key | 400 | キーが存在し、削除されておらず、このclient_idに属していることを確認してください。 |
サーバーで予期しない問題が発生した場合や、リクエストがPOSTでない場合、レスポンスは空のオブジェクト{}になります。statusがない場合は失敗として扱ってください。
ヒント#
- 番号を再接続する:
not_connectedの番号は、WhatsApp設定または番号の接続で再接続できます。 - 1つの番号だけを確認する:単一の番号を確認するには、接続ステータスを使用してください。
- 複数のワークスペース:どのワークスペースの一覧を返すかはAPIキーによって決まります。目的のワークスペースで作成したキーを使用してください。
