1. 有声书-语音搜索专辑列表(audio-search)

1.1 用户界面

手机

适用产品： 搜索，语音助手，智能助手。

适用产品： 搜索，语音助手，智能助手。

1.2 请求

有声读物查询请求：

1、模糊搜索意图，意图名：apiKey=voice-search。

• 场景一：用户使用专辑名（或电台名）搜索，如用户语音搜索“我想听大秦帝国”、“我想听大秦帝国之纵横”、“大秦帝国纵横”。

• 场景二：用户使用艺术家名搜索，如用户语音搜索“我想听孙皓晖的作品”。

• 场景三：用户使用分类名搜索，如用户语音搜索“我想听历史小说”。

• 场景四：用户使用艺术家+专辑名搜索，如用户语音搜索“我想听孙皓晖的大秦帝国”。

• 场景五：用户使用艺术家+分类搜索专辑表，如用户语音搜索“我想听郭德纲的相声”。

上述场景需要返回专辑ID列表，如果开发者已经提供元数据给HAG，可不实现该接口。

2、模糊搜索场景下返回专辑ID列表的场景，不需要支持分页，支持配置最大返回多少条记录，默认最多返回50个专辑记录；最大返回多少条专辑记录，通过pageSize字段传给开发者。

3、参数字段名字说明

• albumName：有声节目的专辑名或电台名。

• artistName：有声节目的表演者或电台的主持人/嘉宾。

• category：有声节目的历史小说，穿越小说或电台的音乐电台，经济电台，交通电台。

• pageSize：分页大小限制。不携带时表示默认值为50。数字描述。

• keyword：搜索电台场景下的搜索关键词。

• province：搜索电台场景下的省份名。

• city：搜索电台场景下的城市名。

请求报文样例：

复制
{
    "slots": {
        "albumName": {
            "name": "albumName",
            "slotType": "string",
            "values": [{
                "real": "大秦帝国之纵横"
            }]
        },
        "artistName": {
            "name": "artistName",
            "slotType": "string",
            "values": [{
                "real": "孙皓晖"
            }]
        },
        "category": {
            "name": "category",
            "slotType": "string",
            "values": [{
                "real": "历史小说"
            }]
        },
        "pageSize": {
            "name": "pageSize",
            "slotType": "string",
            "values": [{
                "real": "50"
            }]
        },
        "keyword": {
            "name": "keyword",
            "slotType": "string",
            "values": [{
                "real": "新闻广播"
            }]
        },
        "province": {
            "name": "province",
            "slotType": "string",
            "values": [{
                "real": "江苏省"
            }]
        },
        "city": {
            "name": "city",
            "slotType": "string",
            "values": [{
                "real": "南京市"
            }]
        }
    }
}

1.3 响应

有声垂类的查询响应

响应报文样例：

复制
{
    "totalCount": 30,
    "audioItemList": [{
        "stream": {
            "url": "xxx"
        },
        "metadata": {
            "contentType": "2",
            "source": "华为音乐",
            "contentExInfo": {}
        }
    }]
}

2. 有声书-查询专辑详情，获取专辑的节目列表(audio-albumDetail)

2.1 请求

有声读物查询请求：

1、根据专辑ID返回专辑里面的节目列表，意图名apiKey=audio-albumDetail，如果开发者已经提供元数据给HAG，可不实现该接口；

2、根据专辑ID查询有声节目列表的场景，需要支持分页；分页请求参数startIndex和pageSize参数；

3、参数字段名字说明：

• albumCode：专辑ID/电台ID，唯一标示一个专辑的索引。

• chapter：章节。取第几章节。数字描述。

• startIndex：分页起始下标。不携带时表示从第1条开始查询。数字描述。

• pageSize：分页大小限制。不携带时表示默认值为50。数字描述。

• orderBy：排序规则。0代表正序，1代表逆序，不携带时表示正序。

请求报文样例：

复制
{
    "albumCode": {
        "name": "albumCode",
        "slotType": "string",
        "values": [{
            "real": "xx"
        }]
    },
    "chapter": {
        "name": "chapter",
        "slotType": "string",
        "values": [{
            "real": "1"
        }]
    },
    "startIndex": {
        "name": "startIndex",
        "slotType": "string",
        "values": [{
            "real": "1"
        }]
    },
    "pageSize": {
        "name": "pageSize",
        "slotType": "string",
        "values": [{
            "real": "50"
        }]
    },
    "orderBy": {
        "name": "orderBy",
        "slotType": "string",
        "values": [{
            "real": "0"
        }]
    }
}

2.2 响应

有声垂类的查询响应

响应报文样例：

复制
{
    "audioItemList": [{
        "stream": {
            "url": "xxx"
        },
        "metadata": {
            "contentType": "19",
            "source": "华为音乐",
            "contentExInfo": {}
        }
    }]
}

3. 有声书-获取节目资源URL(audio-queryContentUrl)

3.1 请求

有声读物查询请求：

1、根据节目ID返回节目URL和节目的资源描述，意图名apiKey=audio-queryContentUrl，如果开发者已经提供带有URL的元数据给HAG，可不实现该接口；

2、参数字段名字说明：contentCode：有声节目ID，唯一标示一个有声节目的ID。

请求报文样例：

复制
{
    "contentCode": {
      "name": "contentCode",
      "slotType": "string",
      "values": [
        {"real":"yy"}
      ]
    }
}

3.2 响应

有声垂类查询节目资源路径的响应

响应报文样例：

复制
{
    "audioItemList": [{
        "stream": {
            "url": "xxx"
        }
    }]
}

4. 结构

4.1 AudioPlayerWithoutMetaItem

有声节目的资源URL

4.2 AudioPlayerAudioWithMetaItem

音频播放条目（带元数据）

4.3 AudioPlayerAudioMetaData

音频元数据

4.4 AudioPlayStream

播放流信息，单独查询某个节目的URL时，采取如下字段返回给端侧播放器播放地址：

在取节目URL时或者查询广播电台场景下是必填，其他场景下是可选。

4.5 AudiobookExInfo

节目的响应内容定义：

4.6 AudioContentPlayListExInfo

收藏类、播放历史的扩展字段：

4.7 AudioContentAlbumExInfo

专辑的响应内容定义

4.8 AudioContentRadioExInfo

返回电台类参数名称

4.9 AudioContentArtistExInfo

艺术家的响应内容定义