General_API
  1. 汎用APIドキュメント
General_API
  • コムデザインAPIドキュメント
    • 汎用API
      • サービス
      • 汎用API共通仕様
      • 汎用APIを利用開始までの流れ
      • 汎用APIドキュメント
        • 通話ステータス通知API
          POST
        • 通話履歴取得API
          POST
        • 待呼取得API
          POST
        • 音声認識結果一括取得API
          POST
        • 音声認識結果取得API
          POST
        • 音声認識結果一括送信API
          POST
        • 音声データ取得API
          POST
        • 使用回線数取得API
          POST
    • AutoCall
      • AutoCallAPIドキュメント
      • AutoCall要求API(順次発信方式)
      • AutoCall要求API(即時発信方式)
      • AutoCall結果取得API
      • AutoCall発信完了通知API
      • AutoCallキャンセルAPI
      • AutoCall架電止めAPI
    • WebSocket(リアルタイム連携)
      • 音声データ連携
        • 音声データ連携ドキュメント
        • WebSocket切断方法
        • WebSocket 音声用API
        • WebSocket 制御用API
      • 音声認識結果連携
        • 音声認識結果連携ドキュメント
        • 音声認識メッセージ
        • 音声認識メッセージ形式
    • 変更履歴
  1. 汎用APIドキュメント

待呼取得API

開発中
POST
/general/{apiVersion}/{sourceUuid}/quecall/info

機能#

現在の待ち呼数を要求します。
リクエストパラメータで着信スキルIDを指定しない場合、全着信スキルの待ち呼を返却します

エラー#

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

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。テナントを一意に特定する
sId
string 
スキルID
必須
CT-e1が発行するスキルID。通話先を指定するためのID(CT-e1の着信スキルID)
例
{
  "tenantId": "05053698341",
  "sId": "S01@05033334444"
}

サンプルコード

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/quecall/info' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "tenantId": "05053698341",
  "sId": "S01@05033334444"
}'

Response

🟢200成功
application/json
Body
status
string 
ステータス
必須
成功:complete 失敗:error
tenantId
string 
テナントID
必須
CT-e1が発行するテナントID。テナントを一意に特定する
queuingList
array [object {4}] 
必須
sId
string 
スキルID
必須
CT-e1が発行するスキルID。通話先を指定するためのID(CT-e1の着信スキルID)
queuing
integer 
待呼数
必須
着信スキルごとの待ち呼数
login
integer 
ログイン数
必須
指定された着信スキルを対応可能かつ、ログイン済みのエージェント数
acceptable
integer 
受付可数
必須
指定された着信スキルを対応可能かつ、受付可ステータスのエージェント数
discription
string 
説明
可選
失敗の場合、失敗原因を表す任意のメッセージ
例
{
    "status": "complete",
    "tenantId": "05053698341",
    "queuingList": [
        {
            "sId": "S01@05033334444",
            "queuing": 0,
            "login": 1,
            "acceptable": 1
        },
        {
            "sId": "S02@05033334444",
            "queuing": 2,
            "login": 1,
            "acceptable": 0
        }
    ],
    "description": ""
}
🟢200失敗
更新日時 2025-06-30 12:55:26
前へ
通話履歴取得API
次へ
音声認識結果一括取得API
Built with