General_API
  1. 汎用APIドキュメント
General_API
  • コムデザインAPIドキュメント
    • サービス
    • 汎用API共通仕様
    • 汎用APIを利用開始までの流れ
    • 汎用APIドキュメント
      • 通話ステータス通知API
        POST
      • 通話履歴取得API
        POST
      • 待呼取得API
        POST
      • 音声認識結果一括取得API
        POST
      • 音声認識結果取得API
        POST
      • 音声認識結果一括送信API
        POST
      • 音声データ取得API
        POST
      • 使用回線数取得API
        POST
    • 変更履歴
  1. 汎用APIドキュメント

使用回線数取得API

開発中
POST
/general/{apiVersion}/{sourceUuid}/line/info
WebRTCGeneral

機能#

テナント単位で現在の使用回線数を要求します
リクエスト間隔は、30秒以上としてください

エラー#

存在しないリクエストパラメータ
リクエストパラメータ不足
許可されていないテナントの情報要求

Requestパラメータ

Pathパラメータ
apiVersion
string 
必須
APIバージョンを示す文字列
サンプル値:
v1
sourceUuid
string 
必須
APIの利用者ごとに発行されるUUID形式の文字列
サンプル値:
d70c9bba-b71f-4021-b68c-0dccb2d99999
Headerパラメータ
Authorization
string 
必須
Bearer e0167b81201d415ab0d7ce9081849999 形式のAPIキーを設定する
APIキーは、事前共有する
Request Bodyパラメータapplication/json
tenantId
string 
テナントID
必須
CT-e1が発行するテナントID。テナントを一意に特定する
例
{
  "tenatId": "05053698341"
}

サンプルコード

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/general/v1/d70c9bba-b71f-4021-b68c-0dccb2d99999/line/info' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenatId": "05053698341"
}'

Response

🟢200成功
application/json
Body
status
string 
ステータス
必須
成功：complete 失敗：error
tenantId
string 
テナントID
必須
CT-e1が発行するテナントID。テナントを一意に特定する
contract
integer 
契約回線数
必須
テナント単位で契約している回線数
occupied
integer 
使用回線数
必須
テナント単位で使用中の回線数
discription
string 
説明
可選
失敗の場合、失敗原因を表す任意のメッセージ
例
{
    "status": "complete",
    "tenantId": "05053698341",
    "contract": 30,
    "occupied": 12,
    "description": ""
}
🟢200失敗
前へ
音声データ取得API
次へ
変更履歴
Built with