購入済み番号の一覧を取得

保存されている所有者が、API認証情報に対応するアカウントと一致する購入済み番号のレコードを一覧表示します。レコードが存在することと、実際の通話テストに成功することは別です。

リクエスト

サーバー側のAPI認証情報を使用し、HTTPSで通信してください。例では環境変数から認証情報を読み取っており、有効な認証情報は含まれていません。HTTPステータスに加え、JSON本文内の status.code も確認してください。これらの従来のハンドラーでは、アプリケーションエラーに対して常にHTTPエラーステータスが設定されるとは限りません。

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

保存済みの単一の電話番号で絞り込むには、省略可能な次のパス形式を使用してください：

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

保存済みの国際電話番号を、国番号を含む数字列で指定してください。代わりにPBX内線番号、番号のUUID、エリアID、プレフィックスIDを渡さないでください。指定した番号は既存のレコードを選択するためのものであり、番号の購入や設定は行いません。

レスポンス

成功時には、response メンバーは、単一番号のパス形式を使用した場合も常に配列です。status.results は配列の長さです。

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "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"
      }
    }
  ]
}

返される番号のフィールド
フィールド	意味
`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`	保存済みの初期料金、月額料金、分単位の料金、および利用可能な通話分数です。このハンドラーは通貨フィールドも最新の見積もりも提供しません。例の値から通貨を推測したり、それらを現在の購入料金の見積もりとして使用したりしないでください。

絞り込みとページ分割

このハンドラーには、ページ分割、ページサイズの上限、明示的な並び順はありません。クエリで選択された、無効扱いになっていないすべてのレコードを返します。サービスが有効な番号だけに絞り込むフィルターや、アーカイブ済み番号を別に表示する機能は実装されていません。返されるレコードの順序が一定であると想定しないでください。

一致する番号がない場合

アカウントに、条件に一致し、かつ無効扱いになっていないレコードが存在しない場合、JSON本文の status.code は 404 となり、メッセージには no numbers found が含まれます。成功を示す空の配列は返しません。メッセージの末尾にはソース参照情報が付加されますが、クライアントはこれを固定の識別子として解析しないでください。

次のステップ

次の条件に該当する場合は numberinfo を使用してください：単一の番号について、従来の追加の登録フィールドと番号参照フィールドが必要な場合です。別の設定操作でルートを変更する前に、音声とメッセージの接続先・送信先を確認してください。