淘宝开放平台 - 文档中心

请求地址：

环境	HTTP请求地址	HTTPS请求地址
正式环境	http://gw.api.taobao.com/router/rest	https://eco.taobao.com/router/rest

公共请求参数：

名称	类型	是否必须	描述
method	String	是	API接口名称。
app_key	String	是	TOP分配给应用的AppKey。
target_app_key	String	否	被调用的目标AppKey，仅当被调用的API为第三方ISV提供时有效。
sign_method	String	是	签名的摘要算法，可选值为：hmac，md5。
sign	String	是	API输入参数签名结果，签名算法介绍请点击这里。
session	String	否	用户登录授权成功后，TOP颁发给应用的授权信息，详细介绍请点击这里。当此API的标签上注明：“需要授权”，则此参数必传；“不需要授权”，则此参数不需要传；“可选授权”，则此参数为可选。
timestamp	String	是	时间戳，格式为yyyy-MM-dd HH:mm:ss，时区为GMT+8，例如：2015-01-01 12:00:00。淘宝API服务端允许客户端请求最大时间误差为10分钟。
format	String	否	响应格式。默认为xml格式，可选值：xml，json。
v	String	是	API协议版本，可选值：2.0。
partner_id	String	否	合作伙伴身份标识。
simplify	Boolean	否	是否采用精简JSON返回格式，仅当format=json时有效，默认值为：false。

名称	类型	是否必须	示例值	描述
search_terms	SearchTermsDTO	可选		搜索条件 key支持songName/singerName/copyrightStatus/publishStatus/keyword
└ value String 可选小幸运搜索的value。songName:歌曲名称；singerName:演唱者名称；lyric:歌词文本（只匹配前50字符）； copyrightStatus：版权状态 0下架/1上架；publishStatus：发布状态 0未发布/1发布; keyword:关键字搜索（与songName/singerName互斥）; lyric:歌词搜索，限制字符数50 └ key String 可选 songName 搜索key：songName/singerName/lyric/copyrightStatus/publishStatus/keyword/lyric
tag_optional	SongCatsSearchDTO	可选		tag搜索条件，tag尽量不要超过50个
└ relation Number 可选 1 标签类目间的关系查询 1 and 2：or cat_tag_codes SongCatTagDTO [] 可选标签组列表 └ tag_codes String [] 可选 tag code列表 └ relation Number 可选 1 tag间的关系查询 1 and 2：or
order_by	Number	可选	1	排序,默认按照最新排序 1最新 2本周最热 3本月最热
page	PagingVO	可选		分页信息
└ page_size Number 可选 20 每页数量 └ page Number 可选 1 页码

名称	类型	描述
music_dto_page	Page	音乐信息
data MusicDTO [] 音乐列表 └ song_name String 派大星歌曲名 singers ArtistDTO [] 演唱者 └ area String United States of America 美国地区 └ gender String M 性别 └ alias String 张三别名 └ artist_name String PO8 艺人名 └ artist_logo String https://pic.xiami.net/musician-avatar/05627c31d37f7844ddd1e36fde6212a8/8ca3fb8850722c1a6e575c8215db6ad4-2688x2688.jpg 艺人封面 └ artist_id Number 910507425 艺人id album AlbumDTO 专辑 └ album_logo String https://pic.xiami.net/images/album/img25/910507425/21003758381470226579.jpg 专辑封面 └ album_name String 回到老学校专辑名 └ company_id Number 1706 厂牌id └ sub_name String Back to the old school 副标题 └ gmt_publish Date 1470153600000 发布时间 └ album_id Number 2100375838 专辑id └ language String 国语语言 └ show_status Number 1 展示状态 tags TagLink [] 标签 └ code String cat_2_1141_4_16417909 标签code └ name_cn String 另类说唱标签名 └ id Number 16417909 标签id └ cover_url String https://pic.xiami.net/images/album/img25/910507425/21003758381470226579.jpg 封面地址 └ duration Number 214000 时长 └ waveform_url String https://img.xiami.net/wave/1776298833_1628375853812.txt 波形图地址 └ copyright_status Number 1 1-版权上架, 0-版权下架 audios AudioDTO [] 音频列表 └ duration Number 214000 时长 └ listen_url String https://m320.xiami.net/425/910507425/2100373543/1776298833_60452555_h.mp3?auth_key=1650855600-0-0-30f0abe02251b78aff7bddeafd69f91e 试听文件地址 └ rate Number 320 码率 └ file_size Number 8588266 文件大小 └ audio_id Number 69651445 音频id └ format String mp3 格式 └ bits Number 0 位数 └ sample_rate Number 44100 采样率 └ quality Number 2 音质 └ song_sub_name String 副标题副标题 └ song_id Number 1776298833 歌曲id lyrics LyricDTO [] 歌词 └ lyric_id Number 10200596 歌词id └ type Number 2 类型 └ lyric_url String https://img.xiami.net/lyric/0/0_14697171111506.lrc 歌词地址 └ music_type Number 1 音乐类型1完整版2剪辑版 └ publish_status Number 1 发布状态 └ deleted_status Number 0 是否删除 └ count Number 339 数量 paging_vo PagingVO 分页信息 └ pages Number 17 总页数 └ count Number 339 总数 └ page_size Number 20 每页数量 └ page Number 1 页码
result_code	ResultCode	结果code
└ msg String success 消息 └ code Number 0 code └ success Boolean true 是否成功

JAVA
.NET
PHP
CURL
Python
C/C++
NodeJS

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XiamiContentMusicInfoQueryRequest req = new XiamiContentMusicInfoQueryRequest();
XiamiContentMusicInfoQueryRequest.SearchTermsDTO obj1 = new XiamiContentMusicInfoQueryRequest.SearchTermsDTO();
obj1.setValue("小幸运");
obj1.setKey("songName");
req.setSearchTerms(obj1);
XiamiContentMusicInfoQueryRequest.SongCatsSearchDTO obj2 = new XiamiContentMusicInfoQueryRequest.SongCatsSearchDTO();
obj2.setRelation(1L);
List<XiamiContentMusicInfoQueryRequest.SongCatTagDTO> list4 = new ArrayList<XiamiContentMusicInfoQueryRequest.SongCatTagDTO>();
XiamiContentMusicInfoQueryRequest.SongCatTagDTO obj5 = new XiamiContentMusicInfoQueryRequest.SongCatTagDTO();
list4.add(obj5);
obj5.setTagCodes("");
obj5.setRelation(1L);
obj2.setCatTagCodes(list4);
req.setTagOptional(obj2);
req.setOrderBy(1L);
XiamiContentMusicInfoQueryRequest.PagingVO obj6 = new XiamiContentMusicInfoQueryRequest.PagingVO();
obj6.setPageSize(20L);
obj6.setPage(1L);
req.setPage(obj6);
XiamiContentMusicInfoQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XiamiContentMusicInfoQueryRequest req = new XiamiContentMusicInfoQueryRequest();
XiamiContentMusicInfoQueryRequest.SearchTermsDTODomain obj1 = new XiamiContentMusicInfoQueryRequest.SearchTermsDTODomain();
obj1.Value = "小幸运";
obj1.Key = "songName";
req.SearchTerms_ = obj1;
XiamiContentMusicInfoQueryRequest.SongCatsSearchDTODomain obj2 = new XiamiContentMusicInfoQueryRequest.SongCatsSearchDTODomain();
obj2.Relation = 1L;
List<XiamiContentMusicInfoQueryRequest.SongCatTagDTODomain> list4 = new List<XiamiContentMusicInfoQueryRequest.SongCatTagDTODomain>();
XiamiContentMusicInfoQueryRequest.SongCatTagDTODomain obj5 = new XiamiContentMusicInfoQueryRequest.SongCatTagDTODomain();
list4.Add(obj5);
obj5.TagCodes = "";
obj5.Relation = 1L;
obj2.CatTagCodes= list4;
req.TagOptional_ = obj2;
req.OrderBy = 1L;
XiamiContentMusicInfoQueryRequest.PagingVODomain obj6 = new XiamiContentMusicInfoQueryRequest.PagingVODomain();
obj6.PageSize = 20L;
obj6.Page = 1L;
req.Page_ = obj6;
XiamiContentMusicInfoQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XiamiContentMusicInfoQueryRequest;
$search_terms = new SearchTermsDTO;
$search_terms->value="小幸运";
$search_terms->key="songName";
$req->setSearchTerms(json_encode($search_terms));
$tag_optional = new SongCatsSearchDTO;
$tag_optional->relation="1";
$cat_tag_codes = new SongCatTagDTO;
$cat_tag_codes->tag_codes="";
$cat_tag_codes->relation="1";
$tag_optional->cat_tag_codes = $cat_tag_codes;
$req->setTagOptional(json_encode($tag_optional));
$req->setOrderBy("1");
$page = new PagingVO;
$page->page_size="20";
$page->page="1";
$req->setPage(json_encode($page));
$resp = $c->execute($req, $sessionKey);

curl -X POST 'http://gw.api.taobao.com/router/rest' \
-H 'Content-Type:application/x-www-form-urlencoded;charset=utf-8' \
-d 'app_key=12129701' \
-d 'format=json' \
-d 'method=xiami.content.music.info.query' \
-d 'partner_id=apidoc' \
-d 'session=cf48a3ce-8ebf-47f0-99ea-9f4ed93a164a' \
-d 'sign=FA36A845D10BF97AF7D947114BF92FE5' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+03%3A27%3A29' \
-d 'v=2.0' \
-d 'order_by=1' \
-d 'page=null' \
-d 'search_terms=null' \
-d 'tag_optional=null'

# -*- coding: utf-8 -*-
import top.api

req=top.api.XiamiContentMusicInfoQueryRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.search_terms="数据结构示例JSON格式"
req.tag_optional="数据结构示例JSON格式"
req.order_by=1
req.page="数据结构示例JSON格式"
try:
	resp= req.getResponse(sessionkey)
	print(resp)
except Exception,e:
	print(e)

pTopRequest pRequest = alloc_top_request();
pTopResponse pResponse = NULL;
pTaobaoClient pClient = alloc_taobao_client(url, appkey, appsecret);
set_api_name(pRequest,"xiami.content.music.info.query");
add_param(pRequest,"search_terms","数据结构JSON示例");
add_param(pRequest,"tag_optional","数据结构JSON示例");
add_param(pRequest,"order_by","1");
add_param(pRequest,"page","数据结构JSON示例");
pResponse = top_execute(pClient,pRequest,sessionKey);
printf("ret code:%d\n",pResponse->code);
if(pResponse->code == 0){
	pTopResponseIterator ite = init_response_iterator(pResponse);
	pResultItem pResultItem = alloc_result_item();
	while(parseNext(ite, pResultItem) == 0){
		printf("%s:%s\n",pResultItem->key,pResultItem->value);
	}
	destroy_response_iterator(ite);
	destroy_result_item(pResultItem);
}
destroy_top_request(pRequest);
destroy_top_response(pResponse);
destroy_taobao_client(pClient);

TopClient = require('./topClient').TopClient;
var client = new TopClient({
	'appkey': 'appkey',
	'appsecret': 'secret',
	'REST_URL': 'http://gw.api.taobao.com/router/rest'
});

client.execute('xiami.content.music.info.query', {
	'search_terms':'数据结构JSON示例',
	'tag_optional':'数据结构JSON示例',
	'order_by':'1',
	'page':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<xiami_content_music_info_query_response>
    <music_dto_page>
        <data>
            <music_d_t_o>
                <song_name>派大星</song_name>
                <singers>
                    <artist_d_t_o>
                        <area>United States of America 美国</area>
                        <gender>M</gender>
                        <alias>张三</alias>
                        <artist_name>PO8</artist_name>
                        <artist_logo>https://pic.xiami.net/musician-avatar/05627c31d37f7844ddd1e36fde6212a8/8ca3fb8850722c1a6e575c8215db6ad4-2688x2688.jpg</artist_logo>
                        <artist_id>910507425</artist_id>
                    </artist_d_t_o>
                </singers>
                <album>
                    <album_logo>https://pic.xiami.net/images/album/img25/910507425/21003758381470226579.jpg</album_logo>
                    <album_name>回到老学校</album_name>
                    <company_id>1706</company_id>
                    <sub_name>Back to the old school</sub_name>
                    <gmt_publish>1470153600000</gmt_publish>
                    <album_id>2100375838</album_id>
                    <language>国语</language>
                </album>
                <show_status>1</show_status>
                <tags>
                    <tag_link>
                        <code>cat_2_1141_4_16417909</code>
                        <name_cn>另类说唱</name_cn>
                        <id>16417909</id>
                    </tag_link>
                </tags>
                <cover_url>https://pic.xiami.net/images/album/img25/910507425/21003758381470226579.jpg</cover_url>
                <duration>214000</duration>
                <waveform_url>https://img.xiami.net/wave/1776298833_1628375853812.txt</waveform_url>
                <copyright_status>1</copyright_status>
                <audios>
                    <audio_d_t_o>
                        <duration>214000</duration>
                        <listen_url>https://m320.xiami.net/425/910507425/2100373543/1776298833_60452555_h.mp3?auth_key=1650855600-0-0-30f0abe02251b78aff7bddeafd69f91e</listen_url>
                        <rate>320</rate>
                        <file_size>8588266</file_size>
                        <audio_id>69651445</audio_id>
                        <format>mp3</format>
                        <bits>0</bits>
                        <sample_rate>44100</sample_rate>
                        <quality>2</quality>
                    </audio_d_t_o>
                </audios>
                <song_sub_name>副标题</song_sub_name>
                <song_id>1776298833</song_id>
                <lyrics>
                    <lyric_d_t_o>
                        <lyric_id>10200596</lyric_id>
                        <type>2</type>
                        <lyric_url>https://img.xiami.net/lyric/0/0_14697171111506.lrc</lyric_url>
                    </lyric_d_t_o>
                </lyrics>
                <music_type>1</music_type>
                <publish_status>1</publish_status>
                <deleted_status>0</deleted_status>
            </music_d_t_o>
        </data>
        <count>339</count>
        <paging_vo>
            <pages>17</pages>
            <count>339</count>
            <page_size>20</page_size>
            <page>1</page>
        </paging_vo>
    </music_dto_page>
    <result_code>
        <msg>success</msg>
        <code>0</code>
        <success>true</success>
    </result_code>
</xiami_content_music_info_query_response>

{
    "xiami_content_music_info_query_response":{
        "music_dto_page":{
            "data":{
                "music_d_t_o":[
                    {
                        "song_name":"派大星",
                        "singers":{
                            "artist_d_t_o":[
                                {
                                    "area":"United States of America 美国",
                                    "gender":"M",
                                    "alias":"张三",
                                    "artist_name":"PO8",
                                    "artist_logo":"https:\/\/pic.xiami.net\/musician-avatar\/05627c31d37f7844ddd1e36fde6212a8\/8ca3fb8850722c1a6e575c8215db6ad4-2688x2688.jpg",
                                    "artist_id":910507425
                                }
                            ]
                        },
                        "album":{
                            "album_logo":"https:\/\/pic.xiami.net\/images\/album\/img25\/910507425\/21003758381470226579.jpg",
                            "album_name":"回到老学校",
                            "company_id":1706,
                            "sub_name":"Back to the old school",
                            "gmt_publish":"1470153600000",
                            "album_id":2100375838,
                            "language":"国语"
                        },
                        "show_status":1,
                        "tags":{
                            "tag_link":[
                                {
                                    "code":"cat_2_1141_4_16417909",
                                    "name_cn":"另类说唱",
                                    "id":16417909
                                }
                            ]
                        },
                        "cover_url":"https:\/\/pic.xiami.net\/images\/album\/img25\/910507425\/21003758381470226579.jpg",
                        "duration":214000,
                        "waveform_url":"https:\/\/img.xiami.net\/wave\/1776298833_1628375853812.txt",
                        "copyright_status":1,
                        "audios":{
                            "audio_d_t_o":[
                                {
                                    "duration":214000,
                                    "listen_url":"https:\/\/m320.xiami.net\/425\/910507425\/2100373543\/1776298833_60452555_h.mp3?auth_key=1650855600-0-0-30f0abe02251b78aff7bddeafd69f91e",
                                    "rate":320,
                                    "file_size":8588266,
                                    "audio_id":69651445,
                                    "format":"mp3",
                                    "bits":0,
                                    "sample_rate":44100,
                                    "quality":2
                                }
                            ]
                        },
                        "song_sub_name":"副标题",
                        "song_id":1776298833,
                        "lyrics":{
                            "lyric_d_t_o":[
                                {
                                    "lyric_id":10200596,
                                    "type":2,
                                    "lyric_url":"https:\/\/img.xiami.net\/lyric\/0\/0_14697171111506.lrc"
                                }
                            ]
                        },
                        "music_type":1,
                        "publish_status":1,
                        "deleted_status":0
                    }
                ]
            },
            "count":339,
            "paging_vo":{
                "pages":17,
                "count":339,
                "page_size":20,
                "page":1
            }
        },
        "result_code":{
            "msg":"success",
            "code":0,
            "success":true
        }
    }
}

XML示例
JSON示例

<error_response>
    <code>50</code>
    <msg>Remote service error</msg>
    <sub_code>isv.invalid-parameter</sub_code>
    <sub_msg>非法参数</sub_msg>
</error_response>

{
	"error_response":{
		"msg":"Remote service error",
		"code":50,
		"sub_msg":"非法参数",
		"sub_code":"isv.invalid-parameter"
	}
}

错误码	错误描述	解决方案

API测试工具错误码查询工具 SDK下载

开放平台

曲库开放平台歌曲API

xiami.content.music.info.query (搜索音乐)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ