淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
msg_ids	Number []	必须	111,222	最大列表长度：20	消息列表
session_code	String	必须	avdffsd		sessionCode
session_id	Number	必须	123213		会话id
user_id	Number	必须	1232132		用户id

名称	类型	示例值	描述
data	MsgReadListResponse	response	data
msg_read_list MsgReadResponse [] list msgReadList └ msg_id Number 123213 msgId └ read_result Boolean true readResult
status_code	String	statusCode	statusCode
status_message	String	statusMessage	statusMessage
is_success	Boolean	false	success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoGuoguoImMsgReadRequest req = new CainiaoGuoguoImMsgReadRequest();
req.setMsgIds("111,222");
req.setSessionCode("avdffsd");
req.setSessionId(123213L);
req.setUserId(1232132L);
CainiaoGuoguoImMsgReadResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoGuoguoImMsgReadRequest req = new CainiaoGuoguoImMsgReadRequest();
req.MsgIds = "111,222";
req.SessionCode = "avdffsd";
req.SessionId = 123213L;
req.UserId = 1232132L;
CainiaoGuoguoImMsgReadResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoGuoguoImMsgReadRequest;
$req->setMsgIds("111,222");
$req->setSessionCode("avdffsd");
$req->setSessionId("123213");
$req->setUserId("1232132");
$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=cainiao.guoguo.im.msg.read' \
-d 'partner_id=apidoc' \
-d 'sign=808BC068C5D395DAF3AFAA0501D32D73' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-29+17%3A00%3A10' \
-d 'v=2.0' \
-d 'msg_ids=111%2C222' \
-d 'session_code=avdffsd' \
-d 'session_id=123213' \
-d 'user_id=1232132'

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

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

req.msg_ids="111,222"
req.session_code="avdffsd"
req.session_id=123213
req.user_id=1232132
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,"cainiao.guoguo.im.msg.read");
add_param(pRequest,"msg_ids","111,222");
add_param(pRequest,"session_code","avdffsd");
add_param(pRequest,"session_id","123213");
add_param(pRequest,"user_id","1232132");
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('cainiao.guoguo.im.msg.read', {
	'msg_ids':'111,222',
	'session_code':'avdffsd',
	'session_id':'123213',
	'user_id':'1232132'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_guoguo_im_msg_read_response>
    <data>
        <msg_read_list>
            <msg_read_response>
                <msg_id>123213</msg_id>
                <read_result>true</read_result>
            </msg_read_response>
        </msg_read_list>
    </data>
    <status_code>statusCode</status_code>
    <status_message>statusMessage</status_message>
    <is_success>false</is_success>
</cainiao_guoguo_im_msg_read_response>

{
    "cainiao_guoguo_im_msg_read_response":{
        "data":{
            "msg_read_list":{
                "msg_read_response":[
                    {
                        "msg_id":123213,
                        "read_result":true
                    }
                ]
            }
        },
        "status_code":"statusCode",
        "status_message":"statusMessage",
        "is_success":false
    }
}

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

cainiao.guoguo.im.msg.read (设置消息已读)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ