跳至主要内容

WebSocket 接口

WebSocket 接口是一种在 WebSocket 连接上建立的双向通信协议。

客户端 ⇔ 服务器之间持续交换命令数据包、命令响应数据包和事件数据包。内部存在三个并行的状态转换系统:与音频供给相关的状态转换系统、与语音段落检测相关的状态转换系统以及与语音识别处理相关的状态转换系统。每个转换系统都有若干个状态,并根据特定的触发器重复进行状态转换。

理解这些原理后,即使不使用为客户端应用程序提供的 Wrp 库(包含在示例程序中),也可以使用本 API。

endpoint

保存日志

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

不保存日志

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

认证

请使用以下任一方法指定 API key。获取方法请参阅API Key 的发行方法

s 命令数据包内,将 API key 指定为 authorization 参数。

authorization={API_KEY}

在 WebSocket 连接开始时的 HTTP 请求头中指定以下任一头。

Authorization: Bearer {API_KEY}
Sec-WebSocket-Protocol: wrp, {API_KEY}

关于 WebSocket 接口通过请求头进行认证的详细信息,请参阅手册的通过 HTTP 请求头发送认证信息的方法