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

WebSocket 音声用API

startRecord#

初期化に必要な情報を伝え、準備が出来るまで、待機する
レスポンスでerrorが送信された場合、CT-e1からdissconnectを送信しWebSocket接続を切断する

リクエスト#

項目名データ型必須説明
type文字列〇“startRecord” 固定値
recordId文字列〇通話処理の識別子(CT-e1生成)
sessionId文字列〇テナント単位の通話ID(転送されても不変)
tenantId文字列〇テナント識別子(CT-e1)
groupId文字列〇局番ID
ani文字列〇発信者番号(非通知時は "anonymous")
dnis文字列〇着信番号
direction整数〇0:着信、1:発信
agentId文字列〇エージェントID(CT-e1)
extension文字列〇内線番号
forwardingSource文字列〇転送元内線番号(それ以外は""、保留時は"0")
dtmf文字列〇IVRで押された番号
call_answered_at文字列任意通話開始時刻(ISO8601形式・GMT)

リクエスト(サンプル)#

{
  "type": "startRecord",
  "recordId": "2122418_CCP230_1003",
  "sessionId": "123456789",
  "groupId": "5071",
  "ani": "08012349999",
  "dnis": "05058089999",
  "direction": 0,
  "agentId": "F10025500",
  "extension": "1002",
  "forwardingSource": "1001",
  "dtmf": "1234",
  "call_answered_at": "2023-06-05T14:16:22Z"
}

レスポンス#

正常時#

項目名データ型必須説明
type文字列〇“startRecord” 固定値
status文字列〇“complete” 固定値

エラー発生時#

項目名データ型必須説明
type文字列〇“startRecord” 固定値
status文字列〇“error” 固定値
description文字列 エラー詳細を設定する

disconnect(CT-e1⇒サーバー)#

CT-e1 から送信した場合は、電話が切断された事を示す
CT-e1は、WebSocketサーバからのdisconnect レスポンスを待ってから WebSocket を切断する

リクエスト#

項目名データ型必須説明
type文字列〇“disconnect” 固定値
reason文字列〇“hangup” 固定値

レスポンス#

正常時#

項目名データ型必須説明
type文字列〇“disconnect” 固定値
reason文字列〇“complete” 固定値

エラー発生時#

項目名データ型必須説明
type文字列〇“disconnect” 固定値
reason文字列〇“error” 固定値
description文字列 エラー詳細を設定する

disconnect(サーバー⇒CT-e1)#

CT-e1は、WebSocketサーバからのdisconnectを受信した場合、WebSocketを切断する
WebSocketサーバは、CT-e1からのdisconnect レスポンスを待ってから WebSocket を切断する

リクエスト#

項目名データ型必須説明
type文字列〇“disconnect” 固定値
reason文字列〇“hangup” 固定値

レスポンス#

正常時#

音声データは全て送っているので、recordFile は有りません
項目名データ型必須説明
type文字列〇“disconnect” 固定値
reason文字列〇“complete” 固定値

エラー発生時#

項目名データ型必須説明
type文字列〇“disconnect” 固定値
reason文字列〇“error” 固定値
description文字列 エラー詳細を設定する
更新日時 2025-07-03 02:43:45
前へ
WebSocket切断方法
次へ
WebSocket 制御用API
Built with