淘宝开放平台

请求地址：

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

名称	类型	是否必须	示例值	描述
user_id	Number	必须	13242314	user id
session_code	String	必须	231423432	session code
source	String	可选	scan	来源
template_content	String	必须	2314324	模板内容
template_id	Number	必须	2314324	模板ID
notify_type	byte	必须	1	通知类型
variable_json	String	必须	[{"mail_no":"12321","phone":"13848122312","num":"n001"}]	变量值

名称	类型	示例值	描述
data	TaskSendMsgDto	data	data
└ result Boolean true result
status_code	String	2	statusCode
status_message	String	3	statusMessage
is_success	Boolean	false	success

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
CainiaoYimaCommunicationTaskSendRequest req = new CainiaoYimaCommunicationTaskSendRequest();
req.setUserId(13242314L);
req.setSessionCode("231423432");
req.setSource("scan");
req.setTemplateContent("2314324");
req.setTemplateId(2314324L);
req.setNotifyType("1");
req.setVariableJson("[{\"mail_no\":\"12321\",\"phone\":\"13848122312\",\"num\":\"n001\"}]");
CainiaoYimaCommunicationTaskSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
CainiaoYimaCommunicationTaskSendRequest req = new CainiaoYimaCommunicationTaskSendRequest();
req.UserId = 13242314L;
req.SessionCode = "231423432";
req.Source = "scan";
req.TemplateContent = "2314324";
req.TemplateId = 2314324L;
req.NotifyType = "1";
req.VariableJson = "[{\"mail_no\":\"12321\",\"phone\":\"13848122312\",\"num\":\"n001\"}]";
CainiaoYimaCommunicationTaskSendResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new CainiaoYimaCommunicationTaskSendRequest;
$req->setUserId("13242314");
$req->setSessionCode("231423432");
$req->setSource("scan");
$req->setTemplateContent("2314324");
$req->setTemplateId("2314324");
$req->setNotifyType("1");
$req->setVariableJson("[{\"mail_no\":\"12321\",\"phone\":\"13848122312\",\"num\":\"n001\"}]");
$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.yima.communication.task.send' \
-d 'partner_id=apidoc' \
-d 'sign=1E92BA2260DB146CD2CA7DBC1E490FBC' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-10+09%3A15%3A07' \
-d 'v=2.0' \
-d 'notify_type=1' \
-d 'session_code=231423432' \
-d 'source=scan' \
-d 'template_content=2314324' \
-d 'template_id=2314324' \
-d 'user_id=13242314' \
-d 'variable_json=%7B%22mail_no%22%3A%2212321%22%2C%22phone%22%3A%2213848122312%22%2C%22num%22%3A%22n001%22%7D'

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

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

req.user_id=13242314
req.session_code="231423432"
req.source="scan"
req.template_content="2314324"
req.template_id=2314324
req.notify_type="1"
req.variable_json="[{\"mail_no\":\"12321\",\"phone\":\"13848122312\",\"num\":\"n001\"}]"
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.yima.communication.task.send");
add_param(pRequest,"user_id","13242314");
add_param(pRequest,"session_code","231423432");
add_param(pRequest,"source","scan");
add_param(pRequest,"template_content","2314324");
add_param(pRequest,"template_id","2314324");
add_param(pRequest,"notify_type","1");
add_param(pRequest,"variable_json","{"mail_no":"12321","phone":"13848122312","num":"n001"}");
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.yima.communication.task.send', {
	'user_id':'13242314',
	'session_code':'231423432',
	'source':'scan',
	'template_content':'2314324',
	'template_id':'2314324',
	'notify_type':'1',
	'variable_json':'{"mail_no":"12321","phone":"13848122312","num":"n001"}'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<cainiao_yima_communication_task_send_response>
    <data>
        <result>true</result>
    </data>
    <status_code>2</status_code>
    <status_message>3</status_message>
    <is_success>false</is_success>
</cainiao_yima_communication_task_send_response>

{
    "cainiao_yima_communication_task_send_response":{
        "data":{
            "result":true
        },
        "status_code":"2",
        "status_message":"3",
        "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.yima.communication.task.send (创建一个消息发送任务)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ