# 唤醒词管理
消息类型 | 名称 | 必须实现 |
---|---|---|
response | set_wakeword | 否,设备需要支持终端自定义唤醒词才需实现 |
request | set_wakeword_result | 否,设备需要支持终端自定义唤醒词才需实现 |
# context
"iflyos_context": {
...
"wakeword": {
"version": "1.1"
}
...
}
参数 | 类型 | 说明 | 必填 |
---|---|---|---|
version | String | 模块版本,现在是1.0 | 是 |
说明
该能力是付费能力,如需使用,请联系商务。
版本说明
版本 | 说明 | 更新日期 |
---|---|---|
1.0 | 基础实现 | 2019-12-12 |
# response
# 设置唤醒词
{
"iflyos_responses": [
...,
{
"header": {
"name": "wakeword.set_wakeword"
},
"payload": {
"url": "https://wakeword.iflyos.cn/your_wakeword",
"wakeword_id": "xxxxxx",
"wakeword": "蓝小飞"
}
}
]
}
参数 | 类型 | 说明 | 必有 |
---|---|---|---|
url | String | 唤醒资源的下载地址。 | 是 |
wakeword_id | String | 唤醒词资源的唯一id。 | 是 |
wakeword | String | 唤醒词资源的内容,代表该唤醒词是触发说法 | 是 |
# 恢复默认唤醒词
当收到这个指令时,设备需要将当前使用的唤醒词恢复为设备的默认唤醒词。
{
"iflyos_responses": [
...,
{
"header": {
"name": "wakeword.reset_wakeword"
},
"payload": {}
}
]
}
# request
# 设置唤醒词结果
{
"iflyos_header": {...},
"iflyos_context": {...},
"iflyos_request": {
"header": {
"name": "wakeword.set_wakeword_result",
"request_id": "xxxxxxxx"
},
"payload": {
"result": "SUCCEED",
"wakeword": "蓝小飞",
"error_type": "DOWNLOAD_ERROR"
}
}
}
参数 | 类型 | 说明 | 必填 |
---|---|---|---|
iflyos_header | Object | 构建的通用 iflyos_header | 是 |
iflyos_context | Object | 构建的通用 iflyos_context | 是 |
result | String | 设置唤醒词的结果,取值为SUCCEED 和FAILED | 是 |
wakeword | String | 唤醒词资源的内容,代表该唤醒词是触发说法。若设置后设备不知道唤醒词的内容(如收到reset_wakeword ,此处上报null。 | 是 |
error_type | String | 设置失败的类型,只有在result 取值为FAILED 时才需出现。error_type见下表 | 否 |
type取值说明
error_type | 说明 |
---|---|
USER_DENY | 用户拒绝设置唤醒词 |
DOWNLOAD_ERROR | 下载唤醒资源失败 |
TIME_OUT | 在特定时间内用户未进行设置确认。我们建议超时时间设置为10分钟 |
UNKONWN | 无法明确知晓原因的失败 |