ホステッドPBX API:テナント

HTTPSと、承認済みのAPI認証情報を用いたHTTP Basic認証を使用してください。認証情報はアプリケーションサーバー上で保管してください。これらのホステッドPBXエンドポイントでは、/hpbx/ を api.multitel.net で使用します。/v3 は挿入しないでください。HTTPの結果と、JSONレスポンス内のアプリケーションレベルの処理結果ステータスの両方を確認してください。

アカウントのPBXテナントを一覧表示する

curl --request POST --user "USERNAME:PASSWORD" \
  "https://api.multitel.net/hpbx/tenants/list/0"

一覧取得操作は、認証されたアカウントのテナントを返します。最後のプレースホルダーセグメントは、エンドポイントのURLパスに必要な形式を満たすためのもので、一覧取得操作ではこれを使って別のアカウントを選択することはありません。

一覧応答の例

{
  "status": {
    "code": "200",
    "msg": "List data"
  },
  "response": [
    {
      "billing_code": "EXAMPLE_BILLING_CODE",
      "isocode": "US",
      "continent_iso": "NA",
      "continent_name": "North America"
    }
  ]
}

テナントの作成と変更

顧客用PBX環境(テナント)の作成はサブスクリプション操作であり、初期設定費用と継続的な料金が発生する場合があります。まず利用可能なサービスプランをお読みください。プラン、ロケーション、ルーティングプロファイルを選ぶ際は、アカウントの権限に応じた最新のリファレンスを使用してください。サンプルIDを自分のアカウント用の選択値として流用しないでください。

作成フィールド意味
hosted_pbx_services_id利用可能なプランに対して返されるサービス ID。
te_rp_id承認済みの発信ルーティングプロファイル。
timezoneAmerica/DetroitのようなIANAタイムゾーン。
te_location_idアカウントで利用可能なロケーションID(必要な場合)。
te_maxextensions / te_maxhunts / te_maxconferences / te_maxvoicemails / te_maxivrsリソース容量は選択したサービスによって制限されます。これらは恣意的な利用権の上書きではありません。

生成された請求コードとサービスの設定状況を確認してから、内線を設定してください。新規の連携や、データを変更する操作の正確なスキーマについては、最新のサブスクリプションAPIリファレンスをご利用ください。

ドキュメントを検索