WebSocket インタフェース

WebSocket インタフェース は、WebSocket 接続上に確立される双方向通信プロトコルです。

クライアント ⇔ サーバ間では継続的に、コマンドパケット、コマンド応答パケット、イベントパケットがやりとりされます。また、内部には、3 個の並行した状態遷移系が存在します。音声供給に関する状態遷移系、発話区間検出に関する状態遷移系、音声認識処理に関する状態遷移系です。各遷移系はいくつかの状態を持ち、固有のトリガーにもとづいて状態遷移を繰り返します。

これらを理解すれば、クライアントアプリケーション用に提供している Wrp ライブラリ（サンプルプログラムに同梱）を使用することなく、本 API を利用することも可能です。

エンドポイント

ログ保存あり

wss://acp-api.amivoice.com/v1/

ログ保存なし

wss://acp-api.amivoice.com/v1/nolog/

認証

以下のいずれかの方法で、APIキーを指定してください。取得方法はAPI キーの発行方法を参照してください。

sコマンドパケット内で、API キーをauthorizationパラメータとして指定する。

authorization={APIキー}

WebSocket 接続開始時の HTTP リクエストヘッダでいずれかのヘッダーを指定する。

Authorization: Bearer {APIキー}

Sec-WebSocket-Protocol: wrp, {APIキー}

WebSocketインタフェースのリクエストヘッダーによる認証の詳細は、マニュアルのHTTP リクエストヘッダで認証情報を送る方法を参照してください。