淘宝开放平台

请求地址：

环境	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。

名称	类型	是否必须	示例值	描述
sender	String	可选	1	sender
page_size	Number	必须	20	pageSize
start_time	Number	可选	0	startTime
page	Number	必须	1	page
end_time	Number	可选	0	endTime

名称	类型	示例值	描述
result	CommonHsfResult		CommonHsfResult
data MessageListResult data └ total String demo total └ pages Number 6 pages message_list Item [] messageList └ send_user_num Number 1 sendUserNum └ sender String jason_zb sender └ msg_id Number 265 msgId └ content String 测试新建站内信-------勿扰 content └ send_time Number 1628475142 sendTime └ success Boolean true success └ state Number 200 state └ message String 成功 message

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaShuqiOriginalBackendMessageListRequest req = new AlibabaShuqiOriginalBackendMessageListRequest();
req.setSender("1");
req.setPageSize(20L);
req.setStartTime(0L);
req.setPage(1L);
req.setEndTime(0L);
AlibabaShuqiOriginalBackendMessageListResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaShuqiOriginalBackendMessageListRequest req = new AlibabaShuqiOriginalBackendMessageListRequest();
req.Sender = "1";
req.PageSize = 20L;
req.StartTime = 0L;
req.Page = 1L;
req.EndTime = 0L;
AlibabaShuqiOriginalBackendMessageListResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaShuqiOriginalBackendMessageListRequest;
$req->setSender("1");
$req->setPageSize("20");
$req->setStartTime("0");
$req->setPage("1");
$req->setEndTime("0");
$resp = $c->execute($req);

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=alibaba.shuqi.original.backend.message.list' \
-d 'partner_id=apidoc' \
-d 'sign=BE1D98648D133FB9EA65A7D3CA826036' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-07-24+23%3A10%3A48' \
-d 'v=2.0' \
-d 'end_time=0' \
-d 'page=1' \
-d 'page_size=20' \
-d 'sender=1' \
-d 'start_time=0'

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

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

req.sender="1"
req.page_size=20
req.start_time=0
req.page=1
req.end_time=0
try:
	resp= req.getResponse()
	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,"alibaba.shuqi.original.backend.message.list");
add_param(pRequest,"sender","1");
add_param(pRequest,"page_size","20");
add_param(pRequest,"start_time","0");
add_param(pRequest,"page","1");
add_param(pRequest,"end_time","0");
pResponse = top_execute(pClient,pRequest,NULL);
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('alibaba.shuqi.original.backend.message.list', {
	'sender':'1',
	'page_size':'20',
	'start_time':'0',
	'page':'1',
	'end_time':'0'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_shuqi_original_backend_message_list_response>
    <result>
        <data>
            <total>demo</total>
            <pages>6</pages>
            <message_list>
                <item>
                    <send_user_num>1</send_user_num>
                    <sender>jason_zb</sender>
                    <msg_id>265</msg_id>
                    <content>测试新建站内信-------勿扰</content>
                    <send_time>1628475142</send_time>
                </item>
            </message_list>
        </data>
        <success>true</success>
        <state>200</state>
        <message>成功</message>
    </result>
</alibaba_shuqi_original_backend_message_list_response>

{
    "alibaba_shuqi_original_backend_message_list_response":{
        "result":{
            "data":{
                "total":"demo",
                "pages":6,
                "message_list":{
                    "item":[
                        {
                            "send_user_num":1,
                            "sender":"jason_zb",
                            "msg_id":265,
                            "content":"测试新建站内信-------勿扰",
                            "send_time":1628475142
                        }
                    ]
                }
            },
            "success":true,
            "state":200,
            "message":"成功"
        }
    }
}

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下载

书旗内容文巢

alibaba.shuqi.original.backend.message.list (站内信列表)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ