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

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
messages	String	必须	[{ "nick": "nick","title": "title","view_data": ["a","b"],"biz_data": {"k1": "v1","k2": "v2"},"biz_id": 0,"send_no": 0,"msg_category": "item", "msg_type": "ItemCreate"} ]		发送的消息。参数说明： nick：接收者，支持子账号，必填 title：展示的标题，必填 biz_id：业务id，同一个业务可以变化多次，即有多个状态的迁移。比如：交易消息的状态迁移。可选 send_no：发送的消息编号，服务端会用appkey+user+send_no对消息做重复发送的控制，必填。 msg_category：分配给isv的允许发送的一级类目。必填 msg_type：分配给isv的允许发送的一级类目下的二级类目，必填。 view_data：json数据，在客户端展示的数据，最多5个。可选。 biz_data：消息跳转到插件，插件需要处理这条消息需要的参数，可选。

名称	类型	示例值	描述
send_results	MessageSendResult []		返回结果
└ nick String nick nick └ err_msg String nick is null 错误描述 └ err_code String isv.invalid-parameter 错误码 └ is_success String false 发送结果

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
JindoucloudMessageSendRequest req = new JindoucloudMessageSendRequest();
req.setMessages("[{ \"nick\": \"nick\",\"title\": \"title\",\"view_data\": [\"a\",\"b\"],\"biz_data\": {\"k1\": \"v1\",\"k2\": \"v2\"},\"biz_id\": 0,\"send_no\": 0,\"msg_category\": \"item\", \"msg_type\": \"ItemCreate\"} ]");
JindoucloudMessageSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
JindoucloudMessageSendRequest req = new JindoucloudMessageSendRequest();
req.Messages = "[{ \"nick\": \"nick\",\"title\": \"title\",\"view_data\": [\"a\",\"b\"],\"biz_data\": {\"k1\": \"v1\",\"k2\": \"v2\"},\"biz_id\": 0,\"send_no\": 0,\"msg_category\": \"item\", \"msg_type\": \"ItemCreate\"} ]";
JindoucloudMessageSendResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new JindoucloudMessageSendRequest;
$req->setMessages("[{ \"nick\": \"nick\",\"title\": \"title\",\"view_data\": [\"a\",\"b\"],\"biz_data\": {\"k1\": \"v1\",\"k2\": \"v2\"},\"biz_id\": 0,\"send_no\": 0,\"msg_category\": \"item\", \"msg_type\": \"ItemCreate\"} ]");
$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=taobao.jindoucloud.message.send' \
-d 'partner_id=apidoc' \
-d 'sign=A09BE6F0F5CBC0083A48992A87D8E2C4' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-04-26+09%3A14%3A13' \
-d 'v=2.0' \
-d 'messages=%7B+%22nick%22%3A+%22nick%22%2C%22title%22%3A+%22title%22%2C%22view_data%22%3A+%5B%22a%22%2C%22b%22%5D%2C%22biz_data%22%3A+%7B%22k1%22%3A+%22v1%22%2C%22k2%22%3A+%22v2%22%7D%2C%22biz_id%22%3A+0%2C%22send_no%22%3A+0%2C%22msg_category%22%3A+%22item%22%2C+%22msg_type%22%3A+%22ItemCreate%22%7D+'

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

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

req.messages="[{ \"nick\": \"nick\",\"title\": \"title\",\"view_data\": [\"a\",\"b\"],\"biz_data\": {\"k1\": \"v1\",\"k2\": \"v2\"},\"biz_id\": 0,\"send_no\": 0,\"msg_category\": \"item\", \"msg_type\": \"ItemCreate\"} ]"
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,"taobao.jindoucloud.message.send");
add_param(pRequest,"messages","{ "nick": "nick","title": "title","view_data": ["a","b"],"biz_data": {"k1": "v1","k2": "v2"},"biz_id": 0,"send_no": 0,"msg_category": "item", "msg_type": "ItemCreate"} ");
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('taobao.jindoucloud.message.send', {
	'messages':'{ "nick": "nick","title": "title","view_data": ["a","b"],"biz_data": {"k1": "v1","k2": "v2"},"biz_id": 0,"send_no": 0,"msg_category": "item", "msg_type": "ItemCreate"} '
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<jindoucloud_message_send_response>
    <send_results>
        <message_send_result>
            <nick>nick</nick>
            <err_msg>nick is null</err_msg>
            <err_code>isv.invalid-parameter</err_code>
            <is_success>false</is_success>
        </message_send_result>
    </send_results>
</jindoucloud_message_send_response>

{
    "jindoucloud_message_send_response":{
        "send_results":{
            "message_send_result":[
                {
                    "nick":"nick",
                    "err_msg":"nick is null",
                    "err_code":"isv.invalid-parameter",
                    "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"
	}
}

错误码	错误描述	解决方案
isv.dup-send	消息重复发送，相同的send_no，无法发送两条	遇到该错误码请勿重试，如果是该业务消息的状态变更，请用不同的send_no
isv.invalid-parameter:msg_category or msg_type	一级类目名称或者二级类目名称错误/不存在，请根据天行给你的类目名称进行发送	遇到该错误码请勿重试，确保一级类目名称跟二级类目名称正确了再重试。
isp.user-service-unavailable	发送的用户名错误，	遇到该错误码请勿重试，确保输入正确的用户名正确了再重试
<sub_code>isv.service-error</sub_code><sub_msg>java.lang.Long cannot be cast to java.lang.Integer</sub_msg>	send_no过长，超过了Integer的范围，	遇到该错误码请勿重试，缩小send_no的到Integer范围内再重试

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

千牛接口

taobao.jindoucloud.message.send (发送消息接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ

用户导航

用户反馈

用户反馈

用户反馈