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. 音声データ連携

音声データ連携ドキュメント

概要#

CT-e1の通話音声をリアルタイムに連携します

API一覧#

API名エンドポイント(例)説明
WebSocket 音声用APIwss://{ドメイン}/audio_streaming/audio/wsstartRecord/disconnectを連携する
WebSocket 制御用APIwss://{ドメイン}/audio_streaming/call/wscallStart/callEndを連携する
※URL名は例です。サーバー側で設計して下さい。

API認証#

HTTP Header に「Authorization: SECRET_API_KEY」を指定する事により認証します
SECRET_API_KEY は、事前共有します
HTTP Header に Authorization が含まれていない場合や不正な場合は、レスポンスコード401-403のエラーを返却します
Authorization: Bearer ***********************

メッセージフォーマット#

メッセージ形式#

メッセージはJSON形式で送受信します

音声形式#

WebSocketのバイナリ形式を使用して送信します
音声は1920サンプル毎(240msec)に送信します
音声は常にLがカスタマ、Rがオペレータになります
音声形式は、2chのμLaw-8kデータがLRLRLRで並んだ形です。wavヘッダーは有りません。
モノラルの場合は、1つの送信が1920バイトに、ステレオの場合は、3840バイトになります
最後に240msecに満たなかった場合は切り捨てられます

ステレオ音声データ形式#

音声形式:uRaw
サンプリング周波数:8000Hz
ビット長:8bit
チャンネル数:2チャンネル
※ 音声の並びは LRLRLRLR となる
※ L側がカスタマ側、R側がオペレーター側になる

シーケンス#

通話開始された場合、制御用WebSocket接続を確立しcallStartを送信します。また、音声用WebSocket接続を確立しStartRecordを送信します
保留・転送操作が行われた場合、disconnectを送信して音声用WebSocket接続を切断します
保留解除・転送再開が行われた場合、再度StartRecordを送信し、音声用WebSocket接続の再接続を行います
切電された場合、dissconectを音声用WebSocket接続を切断します。また、callEndを送信し、制御用WebSocket接続を切断します
音声用WebSocket接続が維持されている期間は、音声データを送信します
通話開始時のcallStartとStartRecord、切電時のcallEndとdisconnectは、非同期処理となるため必ずしもシーケンス図通りの順序とならなず、送信順序が逆転する場合もあります
image.png
更新日時 2025-06-27 10:39:03
前へ
使用回線数取得API
次へ
WebSocket切断方法
Built with