コンテンツにスキップ

API ドキュメント

電話番号検出を数分で統合

ベース URL

https://api.zelnum.com/api/v1

API のホストはコンソールのホストと意図的に分離されており、独立したスケーリングと防御が可能です。そのため本例では api.zelnum.com を使用し、ダッシュボードは app.zelnum.com にあります。

認証

すべてのエンドポイントでは、リクエストヘッダーに API キーが必要です。

レスポンス形式

すべてのエンドポイントは JSON を返します。

典型的なワークフロー

残高取得 — GET /v1/balance
検出を送信(番号) — POST /v1/detect · POST /v1/detect/file
タスクステータス — GET /v1/tasks/{token}
ダウンロード URL — GET /v1/tasks/{token}/result · GET /v1/tasks/{token}/download

単一番号のリアルタイム検査

公式 SDK

Python クライアントはこのページのエンドポイントをラップし、型付きレスポンス、冪等キー、一括結果のダウンロードを扱います。現在、公式に保守している SDK はこれのみです。その他の言語は REST API を直接呼び出してください。

Python — https://github.com/Zelnum/zelnum-python · https://pypi.org/project/zelnum/

リファレンス