淘宝开放平台 - 文档中心

请求地址：

环境	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 []	可选		最大列表长度：999	搜索条件 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 [] 可选标签组列表 └ relation Number 可选 1 tag间的关系查询 1 and 2：or └ tag_codes String [] 可选 tagCodes tag code列表
order_by	Number	可选	1		排序,默认按照最新排序 1最新 2本周最热 3本月最热
page	PagingVo	必须			分页信息
└ page_size Number 必须 20 每页展示数 └ page Number 必须 1 页码

名称	类型	示例值	描述
songs	Page	songs	返回的歌曲信息
song_list SongInfoDto [] data 歌曲列表 singers ArtistDto [] singers 演唱者列表 └ area String China 中国大陆地域 └ gender String M 性别 └ alias String 左小祖咒艺人别名 └ artist_name String 左小祖咒艺人名 └ artist_logo String http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg 艺人头像 └ artist_id Number 1290 艺人id └ song_name String 叔叔喜欢下象棋歌曲名 composers ArtistDto [] composers 作曲人列表 └ area String China 中国大陆地域 └ gender String M 性别 └ alias String 左小祖咒艺人别名 └ artist_name String 左小祖咒艺人名 └ artist_logo String http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg 艺人头像 └ artist_id Number 1290 艺人id artists ArtistDto [] artist 专辑艺人 └ area String China 中国大陆地域 └ gender String M 性别 └ alias String 左小祖咒艺人别名 └ artist_name String 左小祖咒艺人名 └ artist_logo String http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg 艺人头像 └ artist_id Number 1290 艺人id album AlbumDto album 专辑 └ album_logo String http://pic.xiami.net/images/album/img90/1290/7769913111376991311.jpg 专辑封面 └ album_name String 一座城池电影原声带专辑名称 └ sub_name String 一座城池专辑副标题 └ album_status Number 1 专辑状态 1-已发布 0-未发布 └ gmt_publish String 1376582400000 专辑发行时间 └ album_id Number 776991311 专辑id └ language String 纯音乐专辑语种 songwriters ArtistDto [] songwriters 作词人列表 └ area String China 中国大陆地域 └ gender String M 性别 └ alias String 左小祖咒艺人别名 └ artist_name String 左小祖咒艺人名 └ artist_logo String http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg 艺人头像 └ artist_id Number 1290 艺人id producers ArtistDto [] producers 制作人列表 └ area String China 中国大陆地域 └ gender String M 性别 └ alias String 左小祖咒艺人别名 └ artist_name String 左小祖咒艺人名 └ artist_logo String http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg 艺人头像 └ artist_id Number 1290 艺人id tags TagLink [] tags 标签列表 parent TagCatLink parent tag直属类目 parent TagCatLink parent tag根类目 └ code String cat_2_563_4_163873331 根类目code └ name_cn String 流派根类目中文名 └ description String 描述根类目描述 └ pid Number 0 父类目根类目没有父类目，该字段为0 └ id Number 1 根类目id └ name_en String style 根类目英文名 └ code String cat_2_563_4_163873331 直属类目code └ name_cn String 流行直属类目中文名 └ description String 描述直属类目描述 └ pid Number 1232 直属类目根类目，如果为0则该类目为根类目 └ id Number 1 直属类目id └ name_en String popular 直属类目英文名 └ code String cat_2_563_4_163873331 tag code(唯一标识一个tag) └ name_cn String 电子流行 tag名称 └ description String 描述 tag描述 └ pid Number 1232 父类目id └ id Number 1 tag id(唯一标识一个tag) └ name_en String electropop tag英文名 └ copyright_status Number 0 1-版权上架, 0-版权下架 arrangements ArtistDto [] arrangements 编曲人列表 └ area String China 中国大陆地域 └ gender String M 性别 └ alias String 左小祖咒艺人别名 └ artist_name String 左小祖咒艺人名 └ artist_logo String http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg 艺人头像 └ artist_id Number 1290 艺人id lyrics LyricDto [] lyrics 歌词列表 └ lyric_type Number LRC 歌词类型 TXT LRC TRC TLRC TTRC └ lyric_id Number 251062117 歌词id └ lyric_url String http://img.xiami.net/lyric/36/2103473336_1595920458404_5723.LRC 歌词地址 └ song_sub_name String 歌曲副标题歌曲副标题 └ song_id Number 1772118366 歌曲id └ publish_status Number 1 歌曲发布状态, 1-已发布, 0-未发布 └ duration Number 120000 歌曲时长（单位毫秒），没有对应的音频文件时为0 └ waveform_url String http://img.xiami.net//wave/2104408824_1615443436340.txt 波形图文件地址 paging PagingVo paging 分页信息 └ pages Number 1 数据总页数 └ count Number 2 数据总数 └ page_size Number 10 每页展示数 └ page Number 1 页码
result_code	ResultCode	ResultCode	系统自动生成
└ msg String success result message └ code Number 0 result code

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
XiamiContentSongsInfoQueryRequest req = new XiamiContentSongsInfoQueryRequest();
List<XiamiContentSongsInfoQueryRequest.SearchTermsDto> list2 = new ArrayList<XiamiContentSongsInfoQueryRequest.SearchTermsDto>();
XiamiContentSongsInfoQueryRequest.SearchTermsDto obj3 = new XiamiContentSongsInfoQueryRequest.SearchTermsDto();
list2.add(obj3);
obj3.setValue("小幸运");
obj3.setKey("songName");
req.setSearchTerms(list2);
XiamiContentSongsInfoQueryRequest.SongCatsSearchDto obj4 = new XiamiContentSongsInfoQueryRequest.SongCatsSearchDto();
obj4.setRelation(1L);
List<XiamiContentSongsInfoQueryRequest.SongCatTagDto> list6 = new ArrayList<XiamiContentSongsInfoQueryRequest.SongCatTagDto>();
XiamiContentSongsInfoQueryRequest.SongCatTagDto obj7 = new XiamiContentSongsInfoQueryRequest.SongCatTagDto();
list6.add(obj7);
obj7.setRelation(1L);
obj7.setTagCodes("tagCodes");
obj4.setCatTagCodes(list6);
req.setTagOptional(obj4);
req.setOrderBy(1L);
XiamiContentSongsInfoQueryRequest.PagingVo obj8 = new XiamiContentSongsInfoQueryRequest.PagingVo();
obj8.setPageSize(20L);
obj8.setPage(1L);
req.setPage(obj8);
XiamiContentSongsInfoQueryResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
XiamiContentSongsInfoQueryRequest req = new XiamiContentSongsInfoQueryRequest();
List<XiamiContentSongsInfoQueryRequest.SearchTermsDtoDomain> list2 = new List<XiamiContentSongsInfoQueryRequest.SearchTermsDtoDomain>();
XiamiContentSongsInfoQueryRequest.SearchTermsDtoDomain obj3 = new XiamiContentSongsInfoQueryRequest.SearchTermsDtoDomain();
list2.Add(obj3);
obj3.Value = "小幸运";
obj3.Key = "songName";
req.SearchTerms_ = list2;
XiamiContentSongsInfoQueryRequest.SongCatsSearchDtoDomain obj4 = new XiamiContentSongsInfoQueryRequest.SongCatsSearchDtoDomain();
obj4.Relation = 1L;
List<XiamiContentSongsInfoQueryRequest.SongCatTagDtoDomain> list6 = new List<XiamiContentSongsInfoQueryRequest.SongCatTagDtoDomain>();
XiamiContentSongsInfoQueryRequest.SongCatTagDtoDomain obj7 = new XiamiContentSongsInfoQueryRequest.SongCatTagDtoDomain();
list6.Add(obj7);
obj7.Relation = 1L;
obj7.TagCodes = "tagCodes";
obj4.CatTagCodes= list6;
req.TagOptional_ = obj4;
req.OrderBy = 1L;
XiamiContentSongsInfoQueryRequest.PagingVoDomain obj8 = new XiamiContentSongsInfoQueryRequest.PagingVoDomain();
obj8.PageSize = 20L;
obj8.Page = 1L;
req.Page_ = obj8;
XiamiContentSongsInfoQueryResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new XiamiContentSongsInfoQueryRequest;
$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->relation="1";
$cat_tag_codes->tag_codes="tagCodes";
$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.songs.info.query' \
-d 'partner_id=apidoc' \
-d 'session=ebacd1c3-3378-4b2c-90ec-9d46bb6fe27e' \
-d 'sign=C751942D4691949BE4EF2371E930F55D' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-04+03%3A28%3A50' \
-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.XiamiContentSongsInfoQueryRequest(url,port)
req.set_app_info(top.appinfo(appkey,secret))

req.search_terms=""
req.tag_optional=""
req.order_by=1
req.page=""
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.songs.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.songs.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_songs_info_query_response>
    <songs>
        <song_list>
            <song_info_dto>
                <singers>
                    <artist_dto>
                        <area>China 中国大陆</area>
                        <gender>M</gender>
                        <alias>左小祖咒</alias>
                        <artist_name>左小祖咒</artist_name>
                        <artist_logo>http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg</artist_logo>
                        <artist_id>1290</artist_id>
                    </artist_dto>
                </singers>
                <song_name>叔叔喜欢下象棋</song_name>
                <composers>
                    <artist_dto>
                        <area>China 中国大陆</area>
                        <gender>M</gender>
                        <alias>左小祖咒</alias>
                        <artist_name>左小祖咒</artist_name>
                        <artist_logo>http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg</artist_logo>
                        <artist_id>1290</artist_id>
                    </artist_dto>
                </composers>
                <artists>
                    <artist_dto>
                        <area>China 中国大陆</area>
                        <gender>M</gender>
                        <alias>左小祖咒</alias>
                        <artist_name>左小祖咒</artist_name>
                        <artist_logo>http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg</artist_logo>
                        <artist_id>1290</artist_id>
                    </artist_dto>
                </artists>
                <album>
                    <album_logo>http://pic.xiami.net/images/album/img90/1290/7769913111376991311.jpg</album_logo>
                    <album_name>一座城池 电影原声带</album_name>
                    <sub_name>一座城池</sub_name>
                    <album_status>1</album_status>
                    <gmt_publish>1376582400000</gmt_publish>
                    <album_id>776991311</album_id>
                    <language>纯音乐</language>
                </album>
                <songwriters>
                    <artist_dto>
                        <area>China 中国大陆</area>
                        <gender>M</gender>
                        <alias>左小祖咒</alias>
                        <artist_name>左小祖咒</artist_name>
                        <artist_logo>http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg</artist_logo>
                        <artist_id>1290</artist_id>
                    </artist_dto>
                </songwriters>
                <producers>
                    <artist_dto>
                        <area>China 中国大陆</area>
                        <gender>M</gender>
                        <alias>左小祖咒</alias>
                        <artist_name>左小祖咒</artist_name>
                        <artist_logo>http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg</artist_logo>
                        <artist_id>1290</artist_id>
                    </artist_dto>
                </producers>
                <tags>
                    <tag_link>
                        <parent>
                            <parent>
                                <code>cat_2_563_4_163873331</code>
                                <name_cn>流派</name_cn>
                                <description>描述</description>
                                <pid>0</pid>
                                <id>1</id>
                                <name_en>style</name_en>
                            </parent>
                            <code>cat_2_563_4_163873331</code>
                            <name_cn>流行</name_cn>
                            <description>描述</description>
                            <pid>1232</pid>
                            <id>1</id>
                            <name_en>popular</name_en>
                        </parent>
                        <code>cat_2_563_4_163873331</code>
                        <name_cn>电子流行</name_cn>
                        <description>描述</description>
                        <pid>1232</pid>
                        <id>1</id>
                        <name_en>electropop</name_en>
                    </tag_link>
                </tags>
                <copyright_status>0</copyright_status>
                <arrangements>
                    <artist_dto>
                        <area>China 中国大陆</area>
                        <gender>M</gender>
                        <alias>左小祖咒</alias>
                        <artist_name>左小祖咒</artist_name>
                        <artist_logo>http://pic.xiami.net/images/artistlogo/67/15483850525367.jpg</artist_logo>
                        <artist_id>1290</artist_id>
                    </artist_dto>
                </arrangements>
                <lyrics>
                    <lyric_dto>
                        <lyric_type>LRC</lyric_type>
                        <lyric_id>251062117</lyric_id>
                        <lyric_url>http://img.xiami.net/lyric/36/2103473336_1595920458404_5723.LRC</lyric_url>
                    </lyric_dto>
                </lyrics>
                <song_sub_name>歌曲副标题</song_sub_name>
                <song_id>1772118366</song_id>
                <publish_status>1</publish_status>
                <duration>120000</duration>
                <waveform_url>http://img.xiami.net//wave/2104408824_1615443436340.txt</waveform_url>
            </song_info_dto>
        </song_list>
        <paging>
            <pages>1</pages>
            <count>2</count>
            <page_size>10</page_size>
            <page>1</page>
        </paging>
    </songs>
    <result_code>
        <msg>success</msg>
        <code>0</code>
    </result_code>
</xiami_content_songs_info_query_response>

{
    "xiami_content_songs_info_query_response":{
        "songs":{
            "song_list":{
                "song_info_dto":[
                    {
                        "singers":{
                            "artist_dto":[
                                {
                                    "area":"China 中国大陆",
                                    "gender":"M",
                                    "alias":"左小祖咒",
                                    "artist_name":"左小祖咒",
                                    "artist_logo":"http:\/\/pic.xiami.net\/images\/artistlogo\/67\/15483850525367.jpg",
                                    "artist_id":1290
                                }
                            ]
                        },
                        "song_name":"叔叔喜欢下象棋",
                        "composers":{
                            "artist_dto":[
                                {
                                    "area":"China 中国大陆",
                                    "gender":"M",
                                    "alias":"左小祖咒",
                                    "artist_name":"左小祖咒",
                                    "artist_logo":"http:\/\/pic.xiami.net\/images\/artistlogo\/67\/15483850525367.jpg",
                                    "artist_id":1290
                                }
                            ]
                        },
                        "artists":{
                            "artist_dto":[
                                {
                                    "area":"China 中国大陆",
                                    "gender":"M",
                                    "alias":"左小祖咒",
                                    "artist_name":"左小祖咒",
                                    "artist_logo":"http:\/\/pic.xiami.net\/images\/artistlogo\/67\/15483850525367.jpg",
                                    "artist_id":1290
                                }
                            ]
                        },
                        "album":{
                            "album_logo":"http:\/\/pic.xiami.net\/images\/album\/img90\/1290\/7769913111376991311.jpg",
                            "album_name":"一座城池 电影原声带",
                            "sub_name":"一座城池",
                            "album_status":1,
                            "gmt_publish":"1376582400000",
                            "album_id":776991311,
                            "language":"纯音乐"
                        },
                        "songwriters":{
                            "artist_dto":[
                                {
                                    "area":"China 中国大陆",
                                    "gender":"M",
                                    "alias":"左小祖咒",
                                    "artist_name":"左小祖咒",
                                    "artist_logo":"http:\/\/pic.xiami.net\/images\/artistlogo\/67\/15483850525367.jpg",
                                    "artist_id":1290
                                }
                            ]
                        },
                        "producers":{
                            "artist_dto":[
                                {
                                    "area":"China 中国大陆",
                                    "gender":"M",
                                    "alias":"左小祖咒",
                                    "artist_name":"左小祖咒",
                                    "artist_logo":"http:\/\/pic.xiami.net\/images\/artistlogo\/67\/15483850525367.jpg",
                                    "artist_id":1290
                                }
                            ]
                        },
                        "tags":{
                            "tag_link":[
                                {
                                    "parent":{
                                        "parent":{
                                            "code":"cat_2_563_4_163873331",
                                            "name_cn":"流派",
                                            "description":"描述",
                                            "pid":0,
                                            "id":1,
                                            "name_en":"style"
                                        },
                                        "code":"cat_2_563_4_163873331",
                                        "name_cn":"流行",
                                        "description":"描述",
                                        "pid":1232,
                                        "id":1,
                                        "name_en":"popular"
                                    },
                                    "code":"cat_2_563_4_163873331",
                                    "name_cn":"电子流行",
                                    "description":"描述",
                                    "pid":1232,
                                    "id":1,
                                    "name_en":"electropop"
                                }
                            ]
                        },
                        "copyright_status":0,
                        "arrangements":{
                            "artist_dto":[
                                {
                                    "area":"China 中国大陆",
                                    "gender":"M",
                                    "alias":"左小祖咒",
                                    "artist_name":"左小祖咒",
                                    "artist_logo":"http:\/\/pic.xiami.net\/images\/artistlogo\/67\/15483850525367.jpg",
                                    "artist_id":1290
                                }
                            ]
                        },
                        "lyrics":{
                            "lyric_dto":[
                                {
                                    "lyric_type":LRC,
                                    "lyric_id":251062117,
                                    "lyric_url":"http:\/\/img.xiami.net\/lyric\/36\/2103473336_1595920458404_5723.LRC"
                                }
                            ]
                        },
                        "song_sub_name":"歌曲副标题",
                        "song_id":1772118366,
                        "publish_status":1,
                        "duration":120000,
                        "waveform_url":"http:\/\/img.xiami.net\/\/wave\/2104408824_1615443436340.txt"
                    }
                ]
            },
            "paging":{
                "pages":1,
                "count":2,
                "page_size":10,
                "page":1
            }
        },
        "result_code":{
            "msg":"success",
            "code":0
        }
    }
}

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.songs.info.query (搜索歌曲列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ