スタートガイド

Wbiztool APIをはじめる

Wbiztool REST APIを使うと、お使いのソフトウェアから、接続済みのご自身のWhatsApp番号でWhatsAppメッセージを送信できます。アプリ、CRM、Webサイト、自動化ツールから、注文状況のお知らせ、リマインダー、アラートを送信するのに利用できます。

このページでは、すべてのリクエストに共通して必要なことを説明します。最初のメッセージを送信するには、メッセージ送信に進んでください。

ベースURL#

すべてのエンドポイントは次のURLの下にあります。

https://wbiztool.com/api/v1/

ほとんどのエンドポイントは POST リクエストを受け付けます。ボディはJSON（application/json）またはフォームフィールド（application/x-www-form-urlencoded）として送信できます。ファイルをアップロードする場合はmultipart/form-dataを使用してください。一部の参照用エンドポイントは GET を使用します。メソッドは各エンドポイントのページで確認してください。

はじめる前に#

アカウントを作成します。wbiztool.com/signupで登録してください。新規アカウントには50件の無料メッセージが含まれます。
WhatsApp番号を接続します。WhatsApp設定を開いて接続をクリックし、スマートフォンのWhatsAppでQRコードをスキャンします。
APIキーを作成します。設定 → APIキーに移動します。キーを作成できるのはワークスペースのオーナーのみです。各ワークスペースで作成できるキーは最大10個です。

認証#

ほとんどのエンドポイントでは、認証情報を各リクエストのボディで送信します。番号確認APIでは、代わりにAuthorization: Bearerヘッダーを使用します。詳しくは各ページを参照してください。

client_idinteger必須: APIクライアントIDです。設定 → APIキーに表示されています。
api_keystring必須: 同じページにあるAPIキーのいずれかです。キーは秘密にしてください。キーを知っている人は誰でも、あなたの番号からメッセージを送信できます。
whatsapp_clientintegerほとんどのメッセージ送信エンドポイントで必須: 送信に使うWhatsApp番号のIDです。WhatsApp設定のWhatsAppクライアントID列に表示されています。必要かどうかは各エンドポイントのページに記載しています。

リクエストがどのワークスペースに対して実行されるかは、APIキーによって決まります。複数のワークスペースに所属している場合は、送信元にしたいワークスペースで作成したキーを使用してください。

キーが漏洩した場合は、APIキーのページで削除してください。削除したキーはすぐに使えなくなります。

最初のリクエスト#

接続済みの番号からテキストメッセージを送信します。ID、キー、電話番号はご自身の値に置き換えてください。

curl -X POST https://wbiztool.com/api/v1/send_msg/ \
  -H "Content-Type: application/json" \
  -d '{
    "client_id": 12345,
    "api_key": "YOUR_API_KEY",
    "whatsapp_client": 678,
    "msg_type": 0,
    "country_code": "91",
    "phone": "9876543210",
    "msg": "Hi Aman, your order #4821 has shipped and will arrive on Thursday."
  }'

msg_idを含む"status": 1のレスポンスが返れば、メッセージはキューに登録されています。すべてのパラメータの説明とPython、Node.js、PHP版の例は、メッセージ送信をご覧ください。

レスポンスとエラー#

すべてのレスポンスは、statusフィールドを持つJSONオブジェクトです（ただし、/api/v1/status/のヘルスチェックは"status": 200を返します）。

"status": 1はリクエストが成功したことを意味します。
"status": 0は失敗したことを意味します。理由はmessageフィールドに記載されます。

{ "status": 0, "message": "Auth Error: invalid api key" }

HTTPコードだけでなくstatusフィールドを確認してください

エンドポイントによって、エラーはHTTP 400、403、200のいずれかで返ります。必ずJSONボディを読んでstatusを確認してください。また、レスポンスコードが400や403の場合でもHTTPクライアントがボディを解析するようにしてください。リマインダーのエンドポイントは現在、不明なAPIキーに対してHTTP 500のHTMLエラーページを返します。一部のエンドポイントは、JSONのレスポンスにapplication/jsonではなくtext/htmlのラベルを付けて返します。Content-Typeヘッダーの内容にかかわらずボディをJSONとして解析し、Makeやn8nなどのツールではレスポンス形式をJSONに設定してください。

よくある認証エラー：

メッセージ	意味
`Auth Error`	`client_id`または`api_key`がない、ボディが有効なJSONやフォームデータではない、またはリクエストが`POST`ではありません。
`Auth Error - Please send correct API key and Client id`	`api_key`がないか、空です。
`Invalid client id.`または`Invalid Client Id`	`client_id`が整数ではありません（一部のエンドポイントでは、`client_id`がない場合も含みます）。`12345`のように数値で送信してください。
`Auth Error: invalid api key`	キーが存在しない、削除されている、またはこの`client_id`に属していません。
`Demo Account can not access apis`	デモアカウントではAPIを利用できません。
`Not enough credits`	プランの残りメッセージ数がありません。アップグレードするか、次の請求サイクルまでお待ちください。

メッセージのライフサイクル#

API経由で送信したメッセージは、まずキューに登録され、その後あなたのWhatsApp番号から送信されます。各メッセージは次のいずれかのステータスを持ちます。

ステータス	名前	意味
`0`	Created	キューに登録され、送信待ちです。
`1`	Sent	あなたのWhatsApp番号から送信されました。
`2`	Failed	送信できませんでした（例：番号がWhatsAppを利用していない）。
`3`	Cancelled	送信前にキャンセルされました。
`4`	Expired	`expire_after_seconds`の期限までに送信されませんでした。

キューに登録されたメッセージを送信するには、WhatsApp番号が接続されたままである必要があります。送信に使う番号の接続が切れている場合、そのメッセージは再接続されるか期限切れになるまでキューで待機します。接続が切れている番号の未送信メッセージは、90日後に削除されます。

メッセージを追跡するには、レスポンスのmsg_idを保存し、送信時にwebhook URLを指定するか、メッセージのステータスを呼び出してください。

公式クライアントライブラリ#

PythonとNode.js向けのラッパーが、認証とファイルアップロードを処理します。ただし、まだすべてのエンドポイントに正しく対応しているわけではないため、クライアントのメソッドを使う前に各エンドポイントのページを確認してください。

pip install wbiztool-client

npm install wbiztool-client

Python：PyPIのwbiztool-client
Node.js：npmのwbiztool-client

ノーコードで設定したい場合は、Zapier、n8n、Make、Pabbly Connect、Google Sheets、Shopify、WordPressについてアプリと連携をご覧ください。

ドキュメントを見る#

製品ガイド：番号の接続からキャンペーン、リマインダー、Uniboxまで、Wbiztoolダッシュボードの使い方。
メッセージングAPI：メッセージの送信、予約、キャンセル、追跡。
WhatsAppアカウントAPI：番号の接続とステータスの確認。
番号確認API：WhatsAppを利用している番号の一括チェック。
リマインダーAPI：定期リマインダーの作成、一覧表示、キャンセル。
メディアAPI：ファイルのアップロード、一覧表示、取得。
連携：ノーコードやプラグインでの設定。