コンテンツへスキップ
Wbiztool

番号確認API

WhatsApp番号確認のステータス(API)

番号確認タスクの進捗を確認し、タスク内のすべての番号の結果を取得します。番号確認タスクを作成した後、タスクが完了するまでこのエンドポイントをポーリングしてください。

GEThttps://wbiztool.com/api/v1/verification/status/?campaign_id=4521

クイック例#

curl "https://wbiztool.com/api/v1/verification/status/?campaign_id=4521" \
  -H "Authorization: Bearer YOUR_API_KEY"

リクエストパラメータ#

Authorizationheader必須

Bearer YOUR_API_KEY設定 → APIキーにあるキーを使用します。代わりにクエリパラメータapi_keyでキーを渡すこともできますが、ヘッダーを使えばサーバーやプロキシのログにキーが残りません。

campaign_idinteger必須

番号確認の作成で返されたcampaign_idで、クエリ文字列で送信します。APIキーと同じワークスペースの番号確認タスクである必要があります。

レスポンス#

リクエストが成功すると、HTTP 200が返ります。

{
  "status": "success",
  "campaign_id": 4521,
  "campaign_name": "Website leads - September",
  "overall_status": "processing",
  "progress": {
    "total": 3,
    "pending": 1,
    "verified": 1,
    "invalid": 1,
    "completed_percentage": 66.67
  },
  "results": [
    {
      "number": "14155550123",
      "status": "pending",
      "checked_at": null,
      "created_at": "2026-09-16T10:15:00.483101+00:00"
    },
    {
      "number": "919876543210",
      "status": "verified",
      "checked_at": "2026-09-16T10:16:12.204551+00:00",
      "created_at": "2026-09-16T10:15:00.482913+00:00"
    },
    {
      "number": "919876543211",
      "status": "invalid",
      "checked_at": "2026-09-16T10:16:19.915372+00:00",
      "created_at": "2026-09-16T10:15:00.483020+00:00"
    }
  ],
  "created_at": "2026-09-16T10:15:00.471820+00:00",
  "last_updated": "2026-09-16T10:15:00.471820+00:00"
}
フィールド説明
statusstring"success"。エラーの場合は"error"が返ります。
campaign_idinteger確認タスクのID。
campaign_namestringタスクの名前。
overall_statusstringpendingprocessingcompletedのいずれか。全体ステータスの値を参照してください。
progress.totalintegerタスク内の番号の数。
progress.pendingintegerまだ確認されていない番号の数。
progress.verifiedintegerWhatsAppに登録されている番号の数。
progress.invalidintegerinvalidとされた番号の数(WhatsAppに登録されていない、有効な番号ではない、または確認に失敗した)。
progress.completed_percentagenumber確認済みの番号(verified + invalid)のtotalに対する割合(%)。小数点以下2桁に丸められます。
resultsarrayタスク内のすべての番号(番号順)。ページネーションはなく、リスト全体が一度に返されます。
results[].numberstring整形済みの電話番号。
results[].statusstringpendingverifiedinvalidunknownのいずれか。番号ステータスの値を参照してください。
results[].checked_atstring or null番号が確認された日時。pendingの間はnullです。
results[].created_atstring番号が追加された日時。
created_atstringタスクが作成された日時。
last_updatedstringタスクのレコードが最後に変更された日時。番号が確認されても変わらないため、最近の処理状況はchecked_atで確認してください。

すべてのタイムスタンプは、マイクロ秒と+00:00オフセットを含むUTCのISO 8601形式です(例:2026-09-16T10:16:12.204551+00:00)。

番号ステータスの値#

意味
pending確認待ちです。
verified番号はWhatsAppに登録されています。
invalid番号がWhatsAppに登録されていない、有効な電話番号ではない、または処理エラーのため確認できませんでした。有効なはずの番号がinvalidと表示される場合は、新しいタスクでもう一度確認してください。
unknownWbiztoolのサポートによって確認がキャンセルされました。通常の処理でこの値になることはありません。

全体ステータスの値#

意味
pendingまだどの番号も確認されていません。
processing一部の番号は確認済みで、一部はまだpendingです。
completedpendingの番号はありません。

一部の確認がキャンセルされた場合、completedのタスクでもcompleted_percentageが100未満になることがあります。キャンセルされた番号はtotalには含まれますが、割合には含まれないためです。

エラー#

エラーの場合は、status"error"のJSONボディとHTTPエラーコードが返ります。

{ "status": "error", "message": "Campaign not found" }
HTTPメッセージ対処方法
405Only GET method allowedGETリクエストを送信してください。
401API key requiredAuthorization: Bearer YOUR_API_KEYヘッダーを追加してください。
401Invalid API keyキーが存在し、削除または無効化されていないことを確認してください。
400campaign_id is requiredクエリ文字列にcampaign_idを追加してください。
404Campaign not foundIDが存在しない、番号確認タスクではない、または別のワークスペースに属しています。タスクを作成したワークスペースのキーを使用してください。
500Internal server error: …ほとんどの場合、campaign_idが数値ではありません。数字のみを送信してください。

ヒント#

  • ポーリングは控えめに:バックグラウンドでは1回の実行で最大10件の番号が確認されるため、30〜60秒ごとの確認で十分です。大きなタスクには長い時間がかかることがあります。
  • overall_statuscompletedになったらポーリングを止めてください。
  • pendingのまま進まない場合:番号確認には、同じワークスペースでWhatsApp設定から接続したWhatsApp番号が必要です。接続済みの番号がないと、番号は確認されません。接続済みの番号がメッセージ送信中の間も、確認は待機します。
  • 大きなタスク:このエンドポイントは、すべての番号を1つのレスポンスで返します。結果をページごとに取得したり、verifiedの番号だけを取得したりするには、番号確認の結果を使用してください。