開発者

GET/v3/get_document_countries

登録対象国の一覧を取得

現在の電話番号登録カタログに掲載されている国のISOコードと国名を確認します。

このページの内容
  1. 登録対象国を選択する
  2. 国が見つからない場合
  3. リクエスト
  4. レスポンス
  5. エラー
  6. 利用可否と副作用

登録対象国を選択する

電話番号の種類や登録要件をリクエストする前に、このレスポンスから国のISOコードをコピーしてください。電話番号サービスの提供対象国を使用してください。顧客の国籍や住所の国をそのまま使用しないでください。

国が見つからない場合

国が掲載されていないからといって、書類が不要であることや、MultiTELがその国の電話番号を提供できないことを示すわけではありません。登録対象の選択と電話番号の検索は別々に行い、必要な国が選択できない場合はサポートにお問い合わせください。

リクエスト

有効化済みのAPIアカウントの認証情報を使用し、HTTPS経由でアクセスしてください。ベーシック認証と、有効化済みのAPIアカウントのベアラートークンに対応しています。アカウントの制限が適用されます。

GETを使用し、文書に記載されているパラメーターがある場合はURLパスに指定してください。

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

レスポンス

HTTPステータスに加えて、JSON本文のstatus.codeも確認してください。responseは、大文字のisoおよびnameの文字列を含み、国名順に並んだ配列です。この登録カタログは、電話番号の在庫検索や、住所に使用する一般的な国の一覧とは異なります。すべての国、または上流システムの結果の取得可能なすべてのページが返されていることを保証するものではありません。

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

{
  "status": {
    "code": 200,
    "msg": "",
    "results": 1
  },
  "response": [
    {
      "iso": "US",
      "name": "United States"
    }
  ]
}

エラー

  • 500: Unable to load available registration countries: 登録対象国の照会でデータが得られませんでした。時間をおいて再試行してください。正常に取得された空のカタログとして扱わないでください。

利用可否と副作用

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