登録要件を確認する

国と番号タイプを選択する

登録する国を選択し、次に get_document_number_types が返す名前を使用します。その名前を number_type として送信してください。タイプ ID や一般的な番号検索のカテゴリは送信しないでください。

返された指示を読む

関連する本人確認/書類ワークフローのために、要件 ID と関係 ID を保持してください。この呼び出しは要件を返すものであり、ファイルの検証や送信は行いません。返された指示と、選択した番号に固有の要件に従ってください。

エラーを免除と解釈しない

無効な国または国の登録書類なしに関するエラーは、二つの条件を組み合わせたものです。これは登録が不要であることの証明ではありません。検索の失敗や空の結果も、顧客や番号を承認するものではありません。結果が不明確な場合はサポートにお問い合わせください。

リクエスト

有効化された API アカウントの資格情報を HTTPS 経由で使用してください。Basic 認証および有効化された API アカウントのベアラートークンがサポートされます。アカウントの制限が適用されます。

POST で、application/json または application/x-www-form-urlencoded を使用して送信します。

curl --fail-with-body --silent --show-error \
  --user "$API_USER:$API_PASSWORD" \
  --request POST \
  --header "Content-Type: application/json" \
  --data '{"country":"US","number_type":"Local"}' \
  "https://api.multitel.net/v3/get_requirements"

ボディパラメータ
名前	型	必須	説明
`country`	文字列	はい	get_document_countries から取得した国の ISO コード。
`number_type`	文字列	はい	get_document_number_types から取得したタイプ名（例: Local）。大文字と小文字は区別されません。ID ではなく名前を指定してください。

レスポンス

HTTP ステータスに加えて、JSON ボディ内の status.code も確認してください。response は、id、type、attributes を持つ単一の要件リソースであり、返される場合は relationships も含まれます。リソースおよび関係データ内の ID は不透明な値です。省略可能な restriction_message テキストは HTML タグが除去されています。残りのテキストは信頼できる HTML としてではなく、テキストとして扱ってください。ハンドラーは最初の要件リソースを返すため、このレスポンスが網羅的な一覧であると推測しないでください。属性/関係の有無は国およびタイプに依存します。例は完全な固定スキーマではありません。

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

{
  "status": {
    "code": 200,
    "msg": ""
  },
  "response": {
    "id": "REQUIREMENT_ID_FROM_RESPONSE",
    "type": "RESOURCE_TYPE_FROM_RESPONSE",
    "attributes": {
      "restriction_message": "Example country-specific instructions."
    }
  }
}

エラー

400: 国と number_type の検証に失敗しました: 必須の値を両方とも指定してください。検証テキストには書式が含まれる場合があります。
400: Invalid country ISO or No country registration documents required.: このあいまいなメッセージは、それ自体では登録の免除を証明するものではありません。
400: Invalid number type: 返されたタイプ名を使用してください。従来のエラーには Global、Local、Mobile、National、Shared Cost、Toll Free が列挙されています。
500: Unable to load registration requirements for the specified country and number type.: 要件が正常に返されませんでした。後で再試行するか、サポートにお問い合わせください。

可用性と副作用

このカタログ/要件の検索は、本人確認情報の作成、証明書類のアップロード、番号の登録、注文の実行を行いません。
カタログレスポンスの成功は、書類の承認や、選択した番号を有効化できることの確認ではありません。