阿里安全开放平台-阿里聚安全

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
topic	String	必须	item		消息的类型，比如：商品类型为item
biz_ids	String	必须	121341,1213131		消息的bizId,如果有多个bizId，则以英文逗号分隔
version	Number	可选	1	默认值：0	客户端使用的版本号
client_info	String	可选	type=IPHONE,version=1.4		传递客户端的信息

名称	类型	示例值	描述
count	Number	10	标记为已读后，当前还有多少条未读消息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
TpnMessageReadRequest req = new TpnMessageReadRequest();
req.setTopic("item");
req.setBizIds("121341,1213131");
req.setVersion(1L);
req.setClientInfo("type=IPHONE,version=1.4");
TpnMessageReadResponse rsp = client.execute(req, sessionKey);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
TpnMessageReadRequest req = new TpnMessageReadRequest();
req.Topic = "item";
req.BizIds = "121341,1213131";
req.Version = 1L;
req.ClientInfo = "type=IPHONE,version=1.4";
TpnMessageReadResponse rsp = client.Execute(req, sessionKey);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new TpnMessageReadRequest;
$req->setTopic("item");
$req->setBizIds("121341,1213131");
$req->setVersion("1");
$req->setClientInfo("type=IPHONE,version=1.4");
$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=taobao.tpn.message.read' \
-d 'partner_id=apidoc' \
-d 'session=ec77214e-cc62-4454-b297-2fa0402bb458' \
-d 'sign=9633D20F26A5CD4BCDAC919D3F1BD249' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-10-16+01%3A23%3A37' \
-d 'v=2.0' \
-d 'biz_ids=121341%2C1213131' \
-d 'client_info=type%3DIPHONE%2Cversion%3D1.4' \
-d 'topic=item' \
-d 'version=1'

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

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

req.topic="item"
req.biz_ids="121341,1213131"
req.version=1
req.client_info="type=IPHONE,version=1.4"
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,"taobao.tpn.message.read");
add_param(pRequest,"topic","item");
add_param(pRequest,"biz_ids","121341,1213131");
add_param(pRequest,"version","1");
add_param(pRequest,"client_info","type=IPHONE,version=1.4");
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('taobao.tpn.message.read', {
	'topic':'item',
	'biz_ids':'121341,1213131',
	'version':'1',
	'client_info':'type=IPHONE,version=1.4'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<tpn_message_read_response>
    <count>10</count>
</tpn_message_read_response>

{
    "tpn_message_read_response":{
        "count":10
    }
}

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

千牛接口

taobao.tpn.message.read (标记消息为已读)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈