始める前に
エリアの選択に使用するAPIは getareas です。そのレスポンスまたは返された next_function からエリアIDをコピーしてください。米国またはカナダのエリアでは、getstates を使用すると、結果を一つの州に絞り込めます。
結果の確認
HTTPステータスに加えて、JSON本文の status.code を確認してください。成功した結果は response 配列に格納されます。デフォルトのレスポンスは名前順に並べ替えられています。available は推定値です。カタログのフラグを確認するだけで済ませず、選択した番号の実際の機能と登録要件を確認してください。
次の手順の選択
グループ化されていない結果を使用してください。returns_numbers が1の場合、返された next_function は番号検索を指します。値が0の場合、番号は注文時に割り当てられ、パスは注文操作を指します。リクエストを送信する前に、その操作と要件を確認してください。注文リクエストによってアカウントに料金が請求されることがあります。返されたすべてのパスに自動的にリクエストを送信しないでください。
ここには料金は含まれません。購入前に、該当する見積もり、必要書類、および注文手順を確認してください。個別のプレフィックスIDと見積もりIDは、表示された電話番号のプレフィックスから組み立てず、返された値をそのまま保持してください。
表示の詳細設定
compact=1 は、順序をランダムに並べ替えた最大100行のサンプルを返します。より大きな結果セットの一ページを返すものではありません。グループ化すると、集約行と合成IDが作成されます。個別のプレフィックスを選択するには、通常のグループ化されていないレスポンスを使用してください。サンプリングまたはグループ化された結果を根拠に、在庫を網羅している、あるいは機能が正確に分かると判断しないでください。
リクエスト
有効化されたAPIアカウントの認証情報をHTTPS経由で使用してください。Basic認証と、有効化されたAPIアカウントのbearerトークンがサポートされています。アカウントの制限が適用されます。
GETを使用し、任意のパラメーターはクエリ文字列で送信してください。フォーム本文へのフォールバックに依存しないでください。
curl --fail-with-body --silent --show-error \
--user "$API_USER:$API_PASSWORD" \
"https://api.multitel.net/v3/getprefixes/$AREA_ID?state=NY"| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
area_id | string | はい | getareasまたはそのnext_functionからエリア識別子をコピーしてください。内部構造を解釈せずに扱い、自分で組み立てたりハッシュ化したりしないでください。 |
| 名前 | 型 | 必須 | 説明 |
|---|---|---|---|
state | string | いいえ | USおよびCAのエリアにのみ対応します。getstatesで取得した州コード、または州の正式名称を使用してください。コードでは大文字と小文字を区別しません。名称では大文字と小文字の違い、および空白の連続を無視します。他の国を指定した場合や、認識できない空でない値を指定した場合は、APIエラーが返されます。 |
compact | string | いいえ | 任意のサンプルモードです。1、true、またはonを指定します。結果はランダムな順序で、最大100行返されます。結果の一覧をすべて取得するには、このパラメーターを省略してください。このエンドポイントにはページやカーソルはありません。 |
group | integer | いいえ | 表示用の高度な集約設定です。1から6の値を指定すると、行がまとめられ、表示用のプレフィックスがマスクされた状態で返されます。グループのUUIDは合成されたもので、個別のプレフィックスIDの代わりには使用できません。番号検索または注文のためにプレフィックスを選択する前に、グループ化しないリクエストを送信してください。通常の手順では、このパラメーターを省略してください。 |
pid | string | いいえ | MultiTELが提供する任意の在庫選択用の値です。数値形式、またはサポートされている32文字の十六進数形式で指定します。通常の使用では省略してください。認識されない値は通知なく無視されます。この値は電話番号のプレフィックスでも料金プランIDでもありません。 |
レスポンス
標準のstatus/response構造のJSONです。status.resultsは、サンプリングやグループ化を反映した、返された行の数を示します。responseにはプレフィックスオブジェクトが格納されます。料金のフィールドは返されません。通常のグループ化されていないレスポンスでは、uuidはプレフィックスID、area_uuidとcountry_uuidは返された識別子、prefixとnameは表示用の情報です。availableは提供状況の推定値であり、予約を意味しません。needs_registrationとrestrictionsは登録に関する情報を示します。sms_coverage、is_mobile、number_typeはカタログ上の参考情報であり、特定の番号の機能を保証するものではありません。number_typeは空の場合や、カタログ内の別の文字列である場合があるため、固定の列挙値のみを必須としないでください。stateは文字列で、空の場合や、カタログ固有の書式を含む場合があります。latitudeとlongitudeは空の場合があります。meteredとoverflowはカタログのフラグであり、金額ではありません。returns_numbersは、番号一覧取得のルート（1）または注文時に番号を割り当てるルート（0）を選択します。next_functionは、その次のルートを示します。グループ化されたレスポンスには、フォールバック用の機能値を含む、統合された機能情報も含まれます。これらを、すべての番号について確認済みの機能と解釈しないでください。
レスポンスの構造を示す例です。実際のアカウントデータや現在の見積もりではありません。
{
"status": {
"code": 200,
"msg": "",
"results": 1
},
"response": [
{
"uuid": "PREFIX_ID_FROM_RESPONSE",
"area_uuid": "AREA_ID_FROM_RESPONSE",
"country_uuid": "COUNTRY_ID_FROM_RESPONSE",
"prefix": "+1212",
"name": "Example area",
"metered": 0,
"overflow": 0,
"needs_registration": 0,
"restrictions": "",
"state": "NY",
"country_iso": "US",
"is_mobile": 0,
"number_type": "local",
"latitude": "",
"longitude": "",
"available": 12,
"sms_coverage": 1,
"returns_numbers": 1,
"next_function": "v3/getnumbers/PREFIX_ID_FROM_RESPONSE"
}
]
}エラー
- 404: Invalid area ID: 検索手順で最新のエリアIDを取得してください。
- 404: State filter is only available for US and CA: 他の国ではstateを省略してください。
- 404: Invalid state: この国についてgetstatesが返す州を使用してください。
- 404: No prefixes found: 条件に一致するカタログの行が返されませんでした。これは、特定の番号を今後一切注文できないことを示すものではありません。
- 500: エラー: 'Failed loading prefixes': カタログの検索に失敗しました。時間をおいて再試行し、問題が続く場合はサポートにお問い合わせください。
提供状況と副作用
- これは検索の手順であり、注文の確定ではありません。追加のカタログ検索によって提供状況が更新されることがあるため、応答時間は変動する場合があります。
- 料金は返されません。注文する前に、該当する番号または注文の見積もりを取得し、登録要件を確認してください。
- availableを正確な在庫数と見なしたり、ゼロをあらゆる場合に注文不可であるという意味に解釈したり、検索の成功を予約と見なしたりしないでください。注文するまでに提供状況が変わることがあります。