開発者

GET/v3/getmobilecount/{prefix_id}

電話交換局のモバイル在庫を確認する

対象のプリフィックスが表すNPA/NXXの特定時点のモバイル在庫数を取得します。これは可用性のヒントであり、予約や購入の保証ではありません。

このページの内容
  1. サポートされるプリフィックスを選択する
  2. カウントをヒントとして使用する
  3. ゼロ在庫とルックアップ失敗を区別する
  4. リクエスト
  5. レスポンス
  6. エラー
  7. 可用性と副作用

サポートされるプリフィックスを選択する

ディスカバリーから現在の個別モバイルプリフィックスを使用してください。このエンドポイントはNANPA電話交換局を対象としています:NPAはエリアコードを、NXXは電話交換局を識別します。エリアコードのみのプリフィックスは範囲が広すぎます。グループ化された表示IDを送信したり、別の国のプリフィックスが十分な桁数を含んでいるからといってその国のサポートを推測したりしないでください。

カウントをヒントとして使用する

読み取るのは response.count。また response.npa と response.nxx が電話交換局を識別します。これはカバレッジサービスのスナップショットであり、お客様のアカウントのために確保された在庫ではありません。注文の前に、実際の番号、適用される見積もり、および登録要件を確認してください。カウントが成功しても購入が承認されることは決してありません。

ゼロ在庫とルックアップ失敗を区別する

正常な応答でカウントがゼロであることは、APIエラーとは異なります。status.code と status.msg に加えてHTTPステータスも確認してください。タイムアウトやルックアップ失敗は可用性不明として扱い、後でバックオフを使って再試行してください。

リクエスト

有効化されたAPIアカウントの認証情報をHTTPSで使用してください。Basic 認証および有効化されたAPIアカウントのベアラートークンがサポートされています。アカウントの制限が適用されます。

GET メソッドで、プリフィックス識別子をURLパスに指定します。ドキュメント化されたクエリパラメータおよびボディパラメータはありません。

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getmobilecount/$PREFIX_ID"
パスパラメータ
名前型必須説明
prefix_idstringはいディスカバリー応答から個別のプリフィックスIDをコピーしてください。エリアコードのみのプリフィックスやグループ化されたサマリーIDではなく、エリアコード(NPA)と電話交換局(NXX)を含むサポートされたNANPAモバイルプリフィックスを使用してください。識別子は不透明なものとして扱ってください。

レスポンス

JSON本体の status.code をHTTPステータスとともに確認してください。成功した response は status.code 200 と status.msg Results を持ちます。response はリストではなくオブジェクトです。count は整数の在庫スナップショットであり、npa と nxx は三文字の文字列です。status.results はこの連想オブジェクトには存在しません。カウントが 0 ということは、カバレッジルックアップが一致する電話交換局を持たなかったか、ゼロの在庫を返したことを意味します。すべてのサプライヤーや他のディスカバリー経路に番号がないことを証明するものではありません。

レスポンス形状の例示であり、実際のアカウントデータや現在の見積もりではありません。

{
  "status": {
    "code": 200,
    "msg": "Results"
  },
  "response": {
    "count": 42,
    "npa": "212",
    "nxx": "555"
  }
}

エラー

  • 404: プロバイダーが無効です:このサービスではモバイル在庫カバレッジを利用できません。
  • 404: 無効なプリフィックスIDです:ディスカバリーから現在の個別プリフィックスIDを取得してください。
  • 404: 無効なプリフィックスです:保存されたプリフィックスにはNPA/NXXルックアップに必要な桁数が足りません。
  • 500: 在庫カバレッジが失敗しました:上流のルックアップが成功したカバレッジ結果を返しませんでした。後でバックオフ付きで再試行してください。失敗は在庫カウントのゼロではありません。

可用性と副作用

  • この操作は在庫を確認するものであり、注文の発行、番号の予約、購入金額の引き落としは行いません。
  • 在庫は直ちに変わる可能性があります。カバレッジカウントは、アカウント固有の購入可能性や次の番号検索応答と同じ件数を約束するようには調整されていません。
  • ルックアップはカバレッジサービスに接続するため、時間がかかることがあります。すべてのプリフィックスを繰り返しポーリングしたり、タイムアウトやエラーを成功したゼロ在庫として扱ったりしないでください。