用户单词注册
用于导入和导出用户注册单词的API。
获取用户注册单词
可以以JSON格式获取注册单词的列表。
endpoint
GET https://acp-api.amivoice.com/profilewords/<dgn>/<pid>
认证
请在Authorization header中指定APPKEY。
Authorization: Bearer {APPKEY}
请求参数
参数名 | 参数名 | 注释 |
|---|---|---|
| dgn | 连接引擎名称 | 指定类似-a-general的连接引擎名 称。可指定的值请参阅语音识别引擎列表。作为路径参数设置。 |
| pid | profileId | 任意字符串。作为路径参数设置。 |
| adf | 音频数据格式 | 指定16k或8k之一。如果未指定，默认为16k。虽然语音识别引擎可能支持多个采样率，但单词注册将8k和16k视为不同的引擎，因此需要指定其中之一。作为查询参数设置。 |
注意
目前不支持adf参数。将很快支持。请注意，目前无法向8k引擎注册单词。
获取 profile 列表
可以以JSON格式获取 profile 列表。
endpoint
GET https://acp-api.amivoice.com/profilewords/<dgn>/
认证
请在Authorization头中指定APPKEY。
Authorization: Bearer {APPKEY}
请求参数
参数名 | 参数名 | 注释 |
|---|---|---|
| dgn | 连接引擎名 | 指定如-a-general等连接引擎名。可指定的值请参考语音识别引擎列表。作为路径参数设置。 |
| adf | 音频数据格式 | 指定16k或8k之一。不指定时默认为16k。虽然某些语音识别引擎支持多个采样率，但单词注册需要分别指定8k或16k，因为它们被视为不同的引擎。作为查询参数设置。 |
注意
目前不支持"获取 profile 列表"。将很快支持。
注册用户注册单词
可以替换指定语音识别引擎和 profileId 的用户注册单词。
endpoint
POST https://acp-api.amivoice.com/profilewords/<dgn>/<pid>
认证
请在Authorization header中指定APPKEY。
Authorization: Bearer {APPKEY}
请求参数
参数名 | 参数名 | 注释 |
|---|---|---|
| dgn | 连接引擎名称 | 指定类似-a-general的连接引擎名称。可指定的值请参阅语音识别引擎列表。 |
| pid | profileId | 任意字符串。作为路径参数设置。 |
| adf | 音频数据格式 | 指定16k或8k之一。如果未指定，默认为16k。虽然语音识别引擎可能支持多个采样率，但单词注册将8k和16k视为不同的引擎，因此需要指定其中之一。 |
内容类型
Content-Type: application/json
请求正文
字段名 | 说明 | 补充 |
|---|---|---|
profilewords | 单词注册信息 | 以数组形式指定要注册的单词 |
profilewords[].written | 显示 | 指定单词的显示 |
profilewords[].spoken | 读音 | 指定单词的读音 |
profilewords[].classname | 类名 | 指定类名。未设置时可省略。 |
示例
{
"profilewords": [
{
"written": "AMI",
"spoken": "あみ"
},
{
"written": "AOI",
"spoken": "あおい"
},
{
"written": "躑躅森",
"spoken": "つつじもり",
"classname": "名前"
}
]
}
响应
成功时
HTTP状态码: 200 OK
响应正文
字段名 | 说明 | 补充 |
|---|---|---|
profilewords | 单词注册信息 | 以数组形式获取注册的单词 |
profilewords[].written | 显示 | 获取单词的显示 |
profilewords[].spoken | 读音 | 获取单词的读音 |
profilewords[].classname | 类名 | 获取类名。未设置时省略 |
示例
{
"profilewords": [
{
"written": "AMI",
"spoken": "あみ"
},
{
"written": "AOI",
"spoken": "あおい"
},
{
"written": "躑躅森",
"spoken": "つつじもり",
"classname": "名前"
}
]
}
失败时
HTTP状态码: 非200
响应正文
字段名 | 说明 | 补充 |
|---|---|---|
| code | 错误代码 | 表示错误类型的代码 |
| message | 错误消息 | 说明错误详细内容的文本 |
错误代码和错误消息
HTTP状态码 | 响应体 | 错误情况 |
|---|---|---|
| 404 Not Found | {"code":"?","message":"missing dictation grammar file name"} | 未指定听写语法文件名 <dgn> 时 |
| 404 Not Found | {"code":"?","message":"missing profile id"} | 未指定 profileId <pid> 时 |
| 405 Method Not Allowed | {"code":"?","message":"POST method is not allowed"} | 指定POST时 |
| 400 Bad Request | {"code":"-","message":"missing request body"} | 使用POST方法请求但未指定请求体时 |
| 400 Bad Request | {"code":"-","message":"invalid request body (<optionalMessage>)"} | 请求体作为JSON不正确时 |
| 422 Unprocessable Entity | {"code":"-","message":"missing profile words"} | 请求体中指定的JSON格式不符合预期时 |
| 422 Unprocessable Entity | {"code":"-","message":"invalid written: <written>"} | 请求体中指定的JSON中的显示/读音/单词类不正确时 |
| 422 Unprocessable Entity | {"code":"-","message":"invalid written: <spoken>"} | 请求体中指定的JSON中的显示/读音/单词类不正确时 |
| 422 Unprocessable Entity | {"code":"-","message":"invalid written: <className>"} | 请求体中指定的JSON中的显示/读音/单词类不正确时 |
| 401 Unauthorized | {"code":"-","message":"can't verify service authorization"} | APPKEY（service 认证密钥字符串）认证失败时 |
| 401 Unauthorized | {"code":"-","message":"service authorization has expired: <expirationTime> (<expiresIn>)"} | APPKEY（service 认证密钥字符串）认证失败时 |
| 500 Internal Server Error | {"code":"?","message":"unexpected exception occurred (<optionalMessage>)"} | 发生意外异常时 |
示例
{
"code":"?",
"message":"missing dictation grammar file name"
}