開発者

GET/v3/getmobiles/{prefix_id}/{quantity}

利用可能なモバイル番号を検索する

現在のプレフィックスと、モバイル番号在庫が有効化されたアカウントを使用して、対象となるモバイル在庫を検索します。注文する前に、返された番号とプランを一緒に確認してください。

このページの内容
  1. モバイル在庫が有効化されていることを確認する
  2. 各番号をそれ自身の価格選択と組み合わせて保持する
  3. 小さな正の数量を使用する
  4. 在庫切れと検索失敗を区別する
  5. 購入前に再確認する
  6. リクエスト
  7. レスポンス
  8. エラー
  9. 可用性と副作用

モバイル在庫が有効化されていることを確認する

この検索は、顧客アカウントでモバイル番号在庫が有効化された後にのみ使用してください。アカウントのディスカバリーワークフローを通じて、現在の個別モバイルプレフィックスを取得してください。サポートされている経路では、そのプレフィックスのワイヤレス在庫を要求します。一致する固定回線ルーティングメタデータレコードには依存しません。アカウントまたはプレフィックスが有効化されているかどうか不明な場合は、サポートにお問い合わせください。

現在のレガシールートは、不適格なリクエストをすべて確実に拒否するわけではありません。モバイル在庫が有効化されていないアカウントでも通常の在庫を受け取ることがあり、その場合でもレスポンスには依然として info.is_mobile: 1 と表示されます。トールフリーのプレフィックスも、同じラベルが付いたトールフリー在庫ブランチに到達する可能性があります。このラベルだけでモバイルサービスを識別しないでください。また、通常のプレフィックスやトールフリーのプレフィックスをこのエンドポイントに送信しないでください。アカウントで確認済みのモバイルカタログと、有効化されたワークフローを使用してください。

各番号をそれ自身の価格選択と組み合わせて保持する

各候補ごとに、number、info.uuid と、同じエントリの price リストをまとめて保持してください。レスポンスには、プレフィックス/エリア/国のメタデータ、契約条件、および登録制限も含まれます。候補は、最初の価格オプションの月額料金の昇順で並べ替えられます。同額の場合の安定した順序は保証されません。返された番号IDをエリアIDやプレフィックスIDに置き換えたり、別の候補の価格IDと組み合わせたりしないでください。

完全なレスポンスには、追加のメタデータや価格フィールドが含まれる場合があります。返される features、チャネル値、および restrictions は候補の説明であり、通話、SMS、MMS、またはファックスがすでに使用可能であることを保証するものではありません。アカウントの権限、登録、および選択したサービスプランは引き続き適用されます。例のプレースホルダーを有効なIDや価格として扱わないでください。

小さな正の数量を使用する

数量 1 から始めてください。通常のプロバイダーリクエストは、正でない数量を 1 に正規化し、上流の値を 300 で上限設定しますが、その後の結果処理では依然として元の入力が使用されます。そのため、ゼロの数量を指定すると、上流の在庫を要求しながら候補が一切返されないことがあります。他のレガシーブランチは、要求された結果数を一貫して適用するわけではありません。単一の普遍的な上限に依存したり、負の値、小数、または数値以外の値を送信したりしないでください。このルートについて、サポートされている公開検索フィルターや価格IDのボディパラメータは文書化されていません。

在庫切れと検索失敗を区別する

404 レスポンスは、在庫がない、サービスが無効化されている、サプライヤーの検索に失敗した、またはカタログレコードが無効であることを表す場合があります。タイムアウトやプロバイダーの障害は、在庫ゼロが確定したものではなく、可用性が不明なものとして扱ってください。適切な場合は、選択を更新し、バックオフを使用して再試行してください。すべての交換局プレフィックスを繰り返しポーリングすることは避けてください。別途提供されているモバイル在庫数エンドポイントはスナップショットのヒントであり、このアカウントの候補リストの長さと一致するとは限りません。

購入前に再確認する

検索は在庫を確保しません。レビュー済みのブランチは、すでに購入済みの番号を除外しようとしますが、ローカルの予約検索に失敗すると、そのような候補が結果に残ることがあります。可用性、所有権、承認済みの価格、および登録は、購入ワークフローで確認する必要があります。保護された購入リクエストには新たな選択を使用し、購入結果が不確実な場合は、再試行する前にアカウントの在庫を照合してください。候補が返されたというだけの理由で購入しないでください。

リクエスト

許可された送信元IPアドレスから、HTTPS経由で有効化されたAPIアカウントを使用してください。顧客アカウントでモバイル在庫も有効化されている必要があります。API認証だけでは有効化されません。

GET で、現在の個別プレフィックス識別子と正の整数の数量をURLパスに指定します。数量を省略した場合、デフォルトは 1 です。例では 1 を使用してください。このルートは、普遍的な結果上限を一貫して検証または適用するわけではありません。

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/getmobiles/$PREFIX_ID/1"
パスパラメータ
名前型必須説明
prefix_idstringはいディスカバリーで取得した、対象となる個別モバイルプレフィックスの不透明な表示ID。アカウントでサポートされているモバイルのNPA/NXX交換局プレフィックスを使用してください。エリアID、グループ化された表示ID、実際のダイヤルプレフィックス、またはトールフリーのプレフィックスで代用しないでください。
quantityintegerいいえ要求する候補の数。デフォルトは 1 です。控えめな正の整数を指定してください。通常の上流リクエストは数量を 300 で上限設定しますが、これは普遍的に検証される入力やレスポンスサイズの保証ではありません。

レスポンス

HTTPステータスに加えて、JSONボディ内の status.code と status.msg を確認してください。成功した場合、response は番号候補のリストであり、status.msg は Results: の後に返された件数が続く値で、status.results はシリアライズされたリストの長さです。候補の価格はアカウント固有です。説明用の省略された例では、実際の在庫や料金見積もりの代わりにプレースホルダーを使用しています。番号にはプラス記号なしの国番号が含まれます。識別子は不透明な文字列です。

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

{
  "status": {
    "code": 200,
    "msg": "Results: 1",
    "results": 1
  },
  "response": [
    {
      "number": "12025550123",
      "info": {
        "uuid": "NUMBER_ID",
        "prefix_uuid": "PREFIX_ID",
        "country_iso": "US",
        "is_mobile": 1
      },
      "price": [
        {
          "uuid": "PRICE_ID",
          "monthly_price": "ACCOUNT_MONTHLY_PRICE",
          "setup_price": "ACCOUNT_SETUP_PRICE",
          "per_minute": "ACCOUNT_INCOMING_RATE",
          "channels": "PLAN_CHANNELS"
        }
      ],
      "features": [
        "voice",
        "sms",
        "mms",
        "t38"
      ]
    }
  ]
}

エラー

  • 404: プレフィックスID、国、またはエリアが無効です: 個別モバイルプレフィックスの選択を更新してください。
  • 404: 番号が見つかりません: 使用可能な在庫がない、サービスが無効化されている、プロバイダーの検索に失敗した、サポートされていない選択、またはアカウントの制限を意味する場合があります。権威ある在庫数ゼロの証明ではありません。

可用性と副作用

  • 検索は番号をレンタルしたり確保したりせず、レビュー済みの経路では購入金額の引き落としも行いません。在庫プロバイダーに接続するため、時間がかかることがあります。
  • 検索が成功すると、アカウントに関連する番号および価格のキャッシュエントリとクエリログが書き込まれます。検索を繰り返しても、予約、価格の固定、または購入にはなりません。
  • 返された価格、条件、制限、および機能は、選択したアカウントと番号について確認する必要があります。機能ラベルは、アクティベーション、メッセージングの承認、またはテスト済みのサービス機能を証明するものではありません。