淘宝开放平台 - 文档中心

请求地址：

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

名称	类型	是否必须	示例值	更多限制	描述
param	MessageSendParam	可选			参数
└ source_id String 必须 mz-mc 应用id └ variables String 可选 {"abc":"abc"} 变量 └ free_sign_name String 可选签名签名 └ expired_time Number 可选 123 过期时间 └ free_template_code String 可选阿里云短信模板阿里云短信模板 └ receivers String 必须 13366580241 接收人 └ receiver_type Number 可选 1 接收类型 └ mc_child_task_id Number 可选 1 内部字段 └ guid String 必须模板id 模板id └ start_send_time Number 可选 1 发送时间 └ tag String 可选 1 1 attach AttachDto 可选邮件附件 └ attach_type String 可选 1 附件类型 └ attach_name String 可选 1 附件 └ attach_content String 可选 1 附件内容 └ exts String 可选 {"abc":"abc"} 拓展字段

名称	类型	示例值	描述
result	McResult	{}	结果
└ success Boolean true 结果 └ error_code String -1 错误码 model MessageSendResultDto 返回模型 └ id Number 123 流水id └ error_msg String xxx 错误信息

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

TaobaoClient client = new DefaultTaobaoClient(url, appkey, secret);
AlibabaDamaiMcMessageSendRequest req = new AlibabaDamaiMcMessageSendRequest();
AlibabaDamaiMcMessageSendRequest.MessageSendParam obj1 = new AlibabaDamaiMcMessageSendRequest.MessageSendParam();
obj1.setSourceId("mz-mc");
obj1.setVariables("{\"abc\":\"abc\"}");
obj1.setFreeSignName("签名");
obj1.setExpiredTime(123L);
obj1.setFreeTemplateCode("阿里云短信模板");
obj1.setReceivers("13366580241");
obj1.setReceiverType(1L);
obj1.setMcChildTaskId(1L);
obj1.setGuid("模板id");
obj1.setStartSendTime(1L);
obj1.setTag("1");
AlibabaDamaiMcMessageSendRequest.AttachDto obj2 = new AlibabaDamaiMcMessageSendRequest.AttachDto();
obj2.setAttachType("1");
obj2.setAttachName("1");
obj2.setAttachContent("1");
obj1.setAttach(obj2);
obj1.setExts("{\"abc\":\"abc\"}");
req.setParam(obj1);
AlibabaDamaiMcMessageSendResponse rsp = client.execute(req);
System.out.println(rsp.getBody());

ITopClient client = new DefaultTopClient(url, appkey, secret);
AlibabaDamaiMcMessageSendRequest req = new AlibabaDamaiMcMessageSendRequest();
AlibabaDamaiMcMessageSendRequest.MessageSendParamDomain obj1 = new AlibabaDamaiMcMessageSendRequest.MessageSendParamDomain();
obj1.SourceId = "mz-mc";
obj1.Variables = "{\"abc\":\"abc\"}";
obj1.FreeSignName = "签名";
obj1.ExpiredTime = 123L;
obj1.FreeTemplateCode = "阿里云短信模板";
obj1.Receivers = "13366580241";
obj1.ReceiverType = 1L;
obj1.McChildTaskId = 1L;
obj1.Guid = "模板id";
obj1.StartSendTime = 1L;
obj1.Tag = "1";
AlibabaDamaiMcMessageSendRequest.AttachDtoDomain obj2 = new AlibabaDamaiMcMessageSendRequest.AttachDtoDomain();
obj2.AttachType = "1";
obj2.AttachName = "1";
obj2.AttachContent = "1";
obj1.Attach= obj2;
obj1.Exts = "{\"abc\":\"abc\"}";
req.Param_ = obj1;
AlibabaDamaiMcMessageSendResponse rsp = client.Execute(req);
Console.WriteLine(rsp.Body);

$c = new TopClient;
$c->appkey = $appkey;
$c->secretKey = $secret;
$req = new AlibabaDamaiMcMessageSendRequest;
$param = new MessageSendParam;
$param->source_id="mz-mc";
$param->variables="{\"abc\":\"abc\"}";
$param->free_sign_name="签名";
$param->expired_time="123";
$param->free_template_code="阿里云短信模板";
$param->receivers="13366580241";
$param->receiver_type="1";
$param->mc_child_task_id="1";
$param->guid="模板id";
$param->start_send_time="1";
$param->tag="1";
$attach = new AttachDto;
$attach->attach_type="1";
$attach->attach_name="1";
$attach->attach_content="1";
$param->attach = $attach;
$param->exts="{\"abc\":\"abc\"}";
$req->setParam(json_encode($param));
$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.damai.mc.message.send' \
-d 'partner_id=apidoc' \
-d 'sign=6F7E23FA4F4FF7C5BF743C88136B0EB1' \
-d 'sign_method=hmac' \
-d 'timestamp=2025-05-05+16%3A19%3A11' \
-d 'v=2.0' \
-d 'param=null'

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

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

req.param=""
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.damai.mc.message.send");
add_param(pRequest,"param","数据结构JSON示例");
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.damai.mc.message.send', {
	'param':'数据结构JSON示例'
}, function(error, response) {
	if (!error) console.log(response);
	else console.log(error);
})

XML示例
JSON示例

<alibaba_damai_mc_message_send_response>
    <result>
        <success>true</success>
        <error_code>-1</error_code>
        <model>
            <id>123</id>
        </model>
        <error_msg>xxx</error_msg>
    </result>
</alibaba_damai_mc_message_send_response>

{
    "alibaba_damai_mc_message_send_response":{
        "result":{
            "success":true,
            "error_code":"-1",
            "model":{
                "id":123
            },
            "error_msg":"xxx"
        }
    }
}

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

alibaba.damai.mc.message.send (大麦消息中心发送接口)

公共参数

请求参数

响应参数

请求示例

响应示例

异常示例

错误码解释

API工具

如何获得此API

FAQ