購入済み番号を一件取得する

購入済み番号のレコード一件と、その保存済み設定を取得します。この操作は、inventory エンドポイントが返す配列とは異なり、オブジェクトを返します。

リクエスト

サーバー側の API 認証情報を使用し、HTTPS 経由でアクセスしてください。例では環境変数から認証情報を読み込みます。有効な認証情報は含まれていません。HTTP ステータスと併せて、JSON 本文の status.code も確認してください。これらの従来のハンドラーは、アプリケーションエラーに対して必ずしも HTTP エラーステータスを設定するわけではありません。

curl --user "$MULTITEL_API_USER:$MULTITEL_API_PASSWORD" \
  "https://api.multitel.net/v3/numberinfo/12025550100"

必須のパスセグメントには、保存されている国際形式の電話番号を指定します。その番号の UUID や PBX の内線番号ではありません。このハンドラーは、クエリパラメーターもリクエスト本文も使用しません。

レスポンス

これはレスポンス構造を示す例であり、アカウントのデータや現在の料金見積もりではありません。

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "number": "12025550100",
    "uuid": "NUMBER_UUID",
    "description": "Main reception",
    "isocode": "US",
    "config": {
      "uri": "sip:reception@example.com",
      "uri2": "",
      "uri3": "",
      "forward_destination": "",
      "sms_uri": "",
      "sms_forward_destination": ""
    },
    "features": {
      "voice": "1",
      "sms": "1",
      "mms": "0"
    },
    "status": {
      "capacity": {
        "assigned_channels": "2",
        "used_channels": "0",
        "overflow": "0",
        "overage_charge": "0.01"
      },
      "origination": {
        "origination_trunk_id": "ORIGINATION_ID",
        "origination_trunk_name": "ORIGINATION_NAME",
        "origination_country_iso": "US",
        "origination_continent_iso": "NA",
        "origination_continent_name": "North America"
      },
      "service_active": "1",
      "force_codec": "",
      "force_dtmf": ""
    },
    "billing": {
      "cnam": "0",
      "overflow": "0",
      "autorenew": "1",
      "persistent": "0",
      "date_created": "2026-01-01 00:00:00"
    },
    "price": {
      "setup_price": "0.00",
      "monthly_price": "1.00",
      "per_minute": "0.01",
      "free_minutes": "0",
      "remaining_minutes": "0",
      "perminute_charges": "0"
    },
    "needs_registration": "0",
    "vrating": "",
    "country_id": "COUNTRY_REFERENCE",
    "area_id": "AREA_REFERENCE",
    "provider_id": "OPAQUE_LEGACY_REFERENCE"
  }
}

返される番号のフィールド
フィールド	意味
`number, uuid, description, isocode`	保存されている電話番号、内部構造に意味を見いださずに扱う番号識別子、説明、および国コード。
`config`	保存されている音声の宛先、外部転送、SMS の宛先、および SMS 転送のフィールド。このエンドポイントは、これらを編集しません。
`features`	保存されている音声、SMS、および MMS の機能フラグ。従来の保存済みフラグが JSON の真偽値であることは保証されません。
`status.capacity`	割り当て済みおよび使用中のチャネル数、オーバーフロー設定、および保存済みの超過料金。これは保存済みのメタデータであり、最新の容量見積もりや実際の通話テストではありません。
`status.origination`	保存済みの着信元メタデータ。識別子は、その内部構造に意味を見いださずに扱ってください。内部名からアプリケーションのロジックを導き出さないでください。
`status.service_active, force_codec, force_dtmf`	保存済みの有効化設定およびメディア設定のフィールド。フラグだけでは、着信が正常に届くことの証明にはなりません。
`billing`	保存済みの CNAM、オーバーフロー、更新、永続化、および作成に関する値。これらを読み取っても、更新やその他の請求設定は変更されません。
`price`	保存済みの初期費用、月額料金、分単位の料金、および利用可能な通話分数。このハンドラーは、通貨フィールドも最新の見積もりも提供しません。サンプルの値から通貨を推測したり、それらの値を現在の購入見積もりとして使用したりしないでください。

このエンドポイントは、inventory と比較して、さらに needs_registration、vrating、country_id、area_id、provider_id、および price.perminute_charges も返します。これらは従来の保存済みの値であり、別途の本人確認承認レスポンスではありません。参照 ID は、その内部構造に意味を見いださずに扱ってください。適切な検出レスポンスを取得せずに、参照 ID から検出用 URL を組み立てたり、プロバイダーとの対応関係を推測したりしないでください。

一致する番号がない場合

認証されたアカウントで、条件に一致する無効化されていないレコードが見つからない場合、JSON 本文の status.code は 404 で、メッセージには number not found が含まれます。メッセージの末尾に付くソース行情報には依存しないでください。再試行する前に、保存されている番号と inventory を確認してください。

結果の利用

この操作は、保存済みデータの読み取りです。番号の購入、本人確認書類の承認、宛先の変更は行わず、通話、FAX、またはメッセージが届くことも保証しません。番号を設定する際は、有効にした各サービスを個別にテストしてください。