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

概要

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

API一覧

API名	エンドポイント（例）	説明
WebSocket 音声用API	wss://{ドメイン}/audio_streaming/audio/ws	startRecord/disconnectを連携する
WebSocket 制御用API	wss://{ドメイン}/audio_streaming/call/ws	callStart/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ヘッダーは有りません。

モノラルの場合は、１つの送信が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は、非同期処理となるため必ずしもシーケンス図通りの順序とならなず、送信順序が逆転する場合もあります

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

概要#

API一覧#

API認証#

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

メッセージ形式#

音声形式#

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

シーケンス#