コンテンツへスキップ
Wbiztool

WhatsAppアカウントAPI

WhatsAppアカウント一覧API

このAPIを使うと、すべてのWhatsApp番号とその接続状態の完全な一覧を1回の呼び出しで取得できます。接続済み番号の一覧とは異なり、接続が切れている番号も含まれます。

POSThttps://wbiztool.com/api/v1/whatsapp/accounts/

リクエストボディ: JSONまたはフォームフィールド

違いアカウント一覧接続済み番号の一覧
切断された番号と削除された番号を含むはいいいえ
項目のキーwhatsapp_client_idwhatsapp_numberstatusidwhatsapp_client_idwhatsapp_client_numberis_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"
  }'

12345YOUR_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
}
フィールド説明
statusinteger成功時は1、リクエストが失敗した場合は0
whatsapp_clientsarrayこのワークスペースにこれまでに追加されたすべてのWhatsApp番号。成功時のみ含まれます。
whatsapp_clients[].whatsapp_client_idinteger番号のID。ほかのAPI呼び出しでwhatsapp_clientとして指定します。
whatsapp_clients[].whatsapp_numberstring追加時に保存された電話番号。
whatsapp_clients[].statusstringconnectedまたはnot_connected

一覧の並び順は保証されていません。順序が重要な場合はwhatsapp_client_idで並べ替えてください。

成功時のレスポンスにはmessageフィールドがないため、例のようにフォールバックを用意して読み取ってください。

エラー#

メッセージHTTP対処方法
Auth Error200client_idapi_keyの両方を、有効なJSONまたはフォームフィールドとしてPOSTボディで送信してください。
Invalid Client Id403client_id12345のような整数で送信してください。
Auth Error: invalid api key400キーが存在し、削除されておらず、このclient_idに属していることを確認してください。

サーバーで予期しない問題が発生した場合や、リクエストがPOSTでない場合、レスポンスは空のオブジェクト{}になります。statusがない場合は失敗として扱ってください。

ヒント#

  • 番号を再接続するnot_connectedの番号は、WhatsApp設定または番号の接続で再接続できます。
  • 1つの番号だけを確認する:単一の番号を確認するには、接続ステータスを使用してください。
  • 複数のワークスペース:どのワークスペースの一覧を返すかはAPIキーによって決まります。目的のワークスペースで作成したキーを使用してください。