跳至主要内容

一次性 APPKEY 发行

我们提供了发行一次性 APPKEY 的 endpoint。您可以使用在个人页面上显示的 serviceId 和 service 密码来发行一次性 APPKEY。

  • APPKEY 是应用程序使用 AmiVoice API 语音识别服务的服务认证密钥字符串。
  • 一次性 APPKEY 是与个人页面上显示的 [APPKEY] 具有相同功能的服务认证密钥字符串，但不同之处在于它基于发行日期和有效时间设置了有效期截止日期。

endpoint​

POST https://acp-api.amivoice.com/issue_service_authorization

请求​

请求参数​

参数名
必须
说明
sid●指定个人页面连接信息中显示的 serviceId
spw●指定个人页面连接信息中显示的 service 密码
epi有效期。指定要发行的一次性 APPKEY 的使用期限。省略时，将设置为 30000(30 秒)
ipa连接源 IP 地址。可以限制可以使用一次性 APPKEY 的客户端 IP 地址
备注

服务密码与用于登录个人页面的密码不同。

有效期​

可以指定以下任一项：

  • 数值。将成为以毫秒为单位的使用期限。
  • 以 's'(秒)、'm'(分钟)、'h'(小时)、'd'(天数)、'w'(周数)为单位的字符串。例如，可以按以下方式指定：
5m                  5 分钟
2h                  2 小时
100d                100 天
  • 表示时间的 yyyy(/|-)mm(/|-)dd[( |T)hh:mm:ss[.sss][[ ](Z|(+|-)zz[[:]zz])]] 格式的字符串。例如，可以按以下方式指定：
2021/06/30            有效期至 2021 年 6 月 30 日 24 时 0 分 0 秒(2021 年 7 月 1 日 0 时 0 分 0 秒)
2021/07/00            有效期至 2021 年 6 月 30 日 24 时 0 分 0 秒(2021 年 7 月 1 日 0 时 0 分 0 秒)
2021/05/15 12:05:30   有效期至 2021 年 5 月 15 日 12 时 5 分 30 秒

连接源 IP 地址​

可以指定以下任一项：

  • 空字符串
  • 以空格或逗号(,)作为分隔符的多个 IPv4 CIDR 格式 IP 地址的字符串。例如，可以按以下方式指定：
10.1.2.34
192.168.0.0/16
150.249.206.220 150.249.236.100/31

响应​

成功时​

返回一次性 APPKEY 字符串。

失败时​

不返回任何内容。可能是必填项未指定，请检查查询参数。

警告

即使 serviceId 或 service 密码错误，也会发行一次性 APPKEY。使用此无效的一次性 APPKEY 连接语音识别服务时，将会出现认证错误。错误消息因接口等而异。

HTTP 接口的情况​

当 serviceId 或 service 密码任一错误时，根据时机会返回以下任一错误：

{
    /* ... 省略 ... */
    "code":"!","message":"failed to connect to recognizer server"
}
{
    /* ... 省略 ... */
    "code":">","message":"failed to send audio data to recognizer server"
}

WebSocket 接口的情况​

如果 serviceId 错误，s命令将失败。此时，s命令响应将返回如下错误：

s can't connect to recognizer server

如果 serviceId 正确但 service 密码错误，s命令将成功。但是，当实际使用p命令发送音频时，将返回音频识别失败时的错误。

{
    /* ... 省略 ... */
    "code":"!","message":"failed to connect to recognizer server"
}

此外，对于 p 命令还会返回以下错误：

p can't feed audio data to recognizer server