コンテンツへスキップ
Wbiztool

WhatsAppアカウントAPI

接続ステータスAPI

WhatsApp番号のいずれかが接続されていて、メッセージを送信できる状態かどうかを確認します。キャンペーンの前や、新しく接続した番号のリンク完了を待つ間に使用します。/api/v1/whatsapp/status/<id>/は機能しないため、代わりにこのエンドポイントを使用してください。

POSThttps://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
  }'

12345YOUR_API_KEY678はご自身の値に置き換えてください。値の確認場所は認証をご覧ください。

リクエストパラメータ#

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 }
フィールド説明
statusinteger番号が接続されている場合は1。接続されていない場合、またはリクエストが失敗した場合は0
messagestringConnectedDisconnected、またはエラー内容。

WhatsApp設定から削除した番号でもDisconnectedが返ります。

エラー#

メッセージHTTP対処方法
Auth Error200client_idapi_key、数値のwhatsapp_clientを、有効なJSONまたはフォームフィールドとしてPOSTボディで送信してください。
Invalid Client Id403client_id12345のような整数で送信してください。
Auth Error: invalid api key400キーが存在し、削除されておらず、このclient_idに属していることを確認してください。
Auth Error 2200そのwhatsapp_client IDはこのAPIキーのワークスペースにありません。
Demo Account can not access apis200通常のアカウントを使用してください。

ヒント#

  • 送信前に確認する:送信に使う番号の接続が切れている場合、そのメッセージは再接続されるか期限切れになるまでキューで待機します。大量に送信する前にステータスを確認してください。切断された番号の未送信メッセージは、90日後に削除されます。
  • 番号を接続した後Connectedが返るまで、数秒ごとにこのエンドポイントをポーリングしてください。connected Webhookは、このエンドポイントがConnectedを返す数秒前に届くことがあるため、イベントの後も最大1分間ポーリングを続けてください。番号の接続を参照してください。
  • すべての番号をまとめて確認する:1回の呼び出しですべての番号のステータスを取得するには、アカウント一覧を使用してください。