WhatsAppアカウントAPI
接続済みWhatsApp番号の一覧API
ワークスペース内で現在接続されているWhatsApp番号を取得します。送信に使う番号をユーザーに選んでもらう場合や、ほかのAPI呼び出しで使うwhatsapp_client IDを調べる場合に利用できます。
POST
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キーに表示されるAPIクライアントIDです。
api_keystring必須同じページにあるAPIキーです。このキーを作成したワークスペースの一覧が返されます。
公式クライアントを使う#
Pythonクライアントは、このエンドポイントを代わりに呼び出します。
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クライアントは、APIがHTTP 400または403を返すとrequests.exceptions.HTTPErrorを発生させるため、呼び出しをtry/exceptで囲んでください。
Node.jsクライアントのgetWhatsAppClients()は存在しないアドレスを呼び出し、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。ほかのAPI呼び出しでwhatsapp_clientとして指定します。 |
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の両方を、有効なJSONまたはフォームフィールドとしてPOSTボディで送信してください。 |
Invalid Client Id | 403 | client_idは12345のような整数で送信してください。 |
Auth Error: invalid api key | 400 | キーが存在し、削除されておらず、このclient_idに属していることを確認してください。 |
POST以外のリクエストでは空のオブジェクト{}が返ります。予期しないサーバーの問題ではHTML本文とともにHTTP 500が返るため、statusを読む前にレスポンスがJSONであることを確認してください。
ヒント#
- 空の一覧:
"whatsapp_clients": []は、このワークスペースで接続されている番号がないことを意味します。WhatsApp設定または番号の接続で番号を接続してください。 - 複数のワークスペース:どのワークスペースの一覧を返すかはAPIキーによって決まります。目的のワークスペースで作成したキーを使用してください。
- 1つの番号だけを確認する:単一の番号を確認するには、接続ステータスを使用してください。
