通知接口允许AVS通知用户新的内容,可以从Alexa官网或使能Alexa skill. 具体来说,该接口暴露了两条指令,指示你的客户端呈现并清除用户的视觉和音频指示.
这个接口不提供通知内容,它只提供用于通知用户新内容可用的音频和视觉指示符.例如,该产品可能会闪烁黄色指示灯并播放音频文件,此时用户可以通过询问获取任何待处理的通知. “Alexa, what did I miss?” 和 “Alexa, what are my notifications?”
有关流程、请勿打扰、和UX注意事项的信息,参考AVS之Notifications概述
SetIndicator指令
指令提示你的客户端在可以检索通知时呈现视觉和音频指示.客户端可能会在短时间内收到多个SetIndicator指令,如果指令重叠,请考虑这些规则:
- 如果当前指令的assetId与传入指令的assetId匹配,不要播放这个 asset
- 如果当前指令的assetId与传入指令的assetId不匹配,播放当前asset完成后播放传入指令的asset
示例消息
{
"directive": {
"header": {
"namespace": "Notifications",
"name": "SetIndicator",
"messageId": "{{STRING}}"
},
"payload": {
"persistVisualIndicator": {{BOOLEAN}},
"playAudioIndicator": {{BOOLEAN}},
"asset": {
"assetId": "{{STRING}}",
"url": "{{STRING}}"
}
}
}
}
- Header 参数
| 参数 | 描述 | 类型 |
|---|---|---|
| messageId | 用于表示特定消息的唯一ID | string |
- Payload 参数
| 参数 | 描述 | 类型 |
|---|---|---|
| persistVisualIndicator | 如果适用,指定在处理此指令后,产品是否必须显示持续的可视化指示符 | boolean |
| playAudioIndicator | 指定产品在处理此指令时是否必须播放音频指示符 | boolean |
| asset | 包含有关在playAudioIndicator为true时必须播放的音频asset信息 | object |
| asset.assetId | asset的唯一标识符 | string |
| asset.url | 这个asset可以被你的客户端下载和缓存,URL有效时间为60分钟,如果产品离线,或asset不可用,则产品应该播放默认的提示音 | string |
ClearIndicator指令
指令指示你的客户端清除所有活动的视觉和音频指示器
- 如果收到此指令时正在播放音频提示,则应该立即停止
- 如果收到此指令时设置了可视指示符,则应该立即清除
示例消息
{
"directive": {
"header": {
"namespace": "Notifications",
"name": "ClearIndicator",
"messageId": "{{STRING}}"
},
"payload": {
}
}
}
- Header参数
| 参数 | 描述 | 类型 |
|---|---|---|
| messageId | 用于表示特定消息的唯一ID | string |
- Payload参数
这个指令有一个空的Playload
