搜索提示

描述

通过输入相应关键词，根据关键词联想给出包含该关键词的相关歌曲搜索提示。

注意

仅当传入的版权方 VendorId 为 "0（默认）"、"1" 或 "2" 时，才能使用本服务端接口；其余版权方不支持。版权方的详细信息，请联系 ZEGO 商务人员咨询。

接口原型

请求方法：GET
请求地址：https://ktv-api.zego.im/?Action=QueryTips
传输协议：HTTPS
调用频率限制：200 次/秒

请求参数

以下请求参数列表仅列出了接口请求参数和部分公共参数，完整公共参数列表请参考调用方式 - 公共请求参数。

说明

在线 KTV 服务端接口的公共请求参数与实时音视频、实时语音的不同，包含了 VendorId（版权方 ID），请务必阅读上述参考文档。

参数	类型	是否必选	描述
Keyword	String	是	关键词。

请求示例

Untitled

https://ktv-api.zego.im/?Action=QueryTips
&Keyword=我和我的祖国
&<公共请求参数>

Copied!

响应参数

参数	类型	描述
Code	Number	返回码。
Message	String	请求结果的说明信息。
RequestId	String	请求 ID。
Data	Object	响应结果，详情可见 Data。

Data

参数	类型	描述
Tips	Array of String	关键词列表。

响应示例

Untitled

{
    "Code": 0,
    "Message": "succeed",
    "RequestId": "1a6d02a8-66ba-455f-9e05-fe77da6a1f14",
    "Data": {
        "Tips": [
            "我和我的祖国",
            "我和我的祖国童声版",
            "我和我的祖国王菲",
            "我和我的祖国原唱",
            "我和我的祖国伴奏",
            "我和我的祖国时代少年团",
            "我和我的祖国纯音乐",
            "我和我的祖国 钢琴",
            "我和我的祖国一刻也不能分割",
            "我和我的祖国英文版"
        ]
    }
}

Copied!

返回码

以下仅列出了接口业务逻辑相关的部分返回码，完整返回码请参考全局返回码。

返回码	说明	处理建议
320000004	参数非法。	请根据 Message 提示判断非法参数，调整对应参数值。
320010000	AppId 不可用	请联系 ZEGO 技术支持开通版权音乐服务。
320010001	不支持的付费类型。	请联系 ZEGO 技术支持开通版权音乐对应的付费类型。按次计费
320050000	系统错误。	请联系 ZEGO 技术支持。
320050002	系统繁忙。	请稍后重试。
320050003	未定义的引擎错误。	请联系 ZEGO 技术支持。
320050004	引擎内部错误。	请联系 ZEGO 技术支持。