登録用の番号種別一覧を取得

返された名前で種別を選択

国の選択には、次のAPIが返す国を使用してください: get_document_countries。返された種別名を次のAPIに渡してください: get_requirements。種別カタログのIDは、プレフィックスID、番号ID、証明書類カテゴリIDとは異なります。

グループ数は電話番号の在庫数ではありません

available_groups は、このカタログ照会で返されたグループレコードの数を表します。購入可能な電話番号の数を表すものではなく、在庫を確保するものでも、取得元の全ページをカタログが取得し終えたことを保証するものでもありません。該当する電話番号の在庫を検索し、見積もりは別途確認してください。

リクエスト

有効化されたAPIアカウントの認証情報を使用し、HTTPSでアクセスしてください。Basic認証と、有効化されたAPIアカウントのbearerトークンに対応しています。アカウントの制限が適用されます。

GETを使用し、ドキュメントに記載されているパラメータはURLパスに指定してください。

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  "https://api.multitel.net/v3/get_document_number_types/$COUNTRY_ISO"

パスパラメータ
名前	型	必須	説明
`country`	string	はい	登録対象国カタログにある、英字二文字の国のISOコードです。前後の空白が除去され、大文字に変換されます。

レスポンス

HTTPステータスに加え、JSON本文のstatus.codeも確認してください。responseは、id、name、available_groupsを含む配列です。nameをnumber_typeとして指定してget_requirementsを呼び出してください。代わりにidを送信しないでください。available_groupsは、その種別について返されたグループレコードの数であり、電話番号の在庫数や、ページ分割された結果全体の総数ではありません。返されたグループがない種別は省略されます。優先される順序はLocal、Mobile、National、Toll Free、Shared Cost、Globalで、その後にカタログのその他の名前が続きます。

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "id": "NUMBER_TYPE_ID_FROM_RESPONSE",
      "name": "Local",
      "available_groups": 3
    }
  ]
}

エラー

400: country is required: 登録対象国のISOコードを指定してください。
400: Invalid country ISO or no available DID registration country found: 現在の登録カタログから国を選択してください。このエラーは、書類が不要であることを示すものではありません。

利用可否と副作用

このカタログ照会・要件照会では、本人情報の作成、証明書類のアップロード、番号の登録、注文の実行は行われません。
カタログから正常なレスポンスが返っても、提出書類が承認されたことや、選択した番号を有効化できることが確認されたことにはなりません。