/message/send
目录 |
/message/send
- 触发交易邮件(简化接口)
URL
- {HOST}/services /message/send
支持格式
- XML(Atom)
HTTP 请求方式
- POST
认证方式
请求数限制
- true
请求参数
| 字段名称 | 是否必选 | 字段类型 | 说明 |
|---|---|---|---|
| auth | 是 | String | BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种 |
| alt | 是 | String | 通过该参数，你可以改变返回值的格式，目前支持的返回值格式包括：atom(默认) ，暂不支持json |
| um:subject | 是 | String | 邮件主题 |
| um:to | 是 | String | 收件人 |
| um:from | 否 | String | 邮件From地址 |
| um:reply | 否 | String | 邮件回复地址 |
| content | 是 | String | 邮件内容 |
| link | 否 | String | 邮件名称 |
| link | 否 | String | 联系人列表名称 |
| 触发邮件使用说明 |
1. 如果邮件地址Email 错误：系统自动跳过 2. 如果该联系人，已退订过. 系统自动跳过 3．如果发送量已用完. 系统自动跳过 4. 如果联系人数超过公司购买联系人数，多余的部分。系统自动跳过 5. 一次调用的触发邮件联系人数被限制在100以下，如果超过100.系统将自动拒绝 6. queued = 加入队列; deleted=联系人已被删除(不发送);invalided=邮件地址无效(不发送);unsubscribed=联系人被退订(不发送) 7. warning=recipientsQuotaReached=联系人已达指标(警告);warning=messagesQuotaReached=邮件已达指标(警告);警告超过信用值将不予发送 8.um:upgrade API发送计划每个月将自动生成一个当月发送计划，如果用户使用的不是当月发送计划。就出现该 um:upgrade 属性.link链接href属性中存放当前月应该更新的触发发送计划。 9.动态链接追踪规则，在需要追踪的<a> 标签里添加link属性，link不能使用纯数字。 |
请求字符串
<?xml version="1.0" encoding="GBK"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:um="http://www.unimarketing.com.cn/xmlns/">
<um:subject>,Example.com用户注册激活</um:subject>
<um:to type="text">wang.j@someone.com</title>
<um:from>DJ<service@example.com></um:from>
<um:reply>service@example.com</um:reply>
<content>
<![CDATA[这里是内容
<a link="tlink1" href="http://www.example.com">链接示例1</a>
<a link="tlink2" href="http://www.example.com">链接示例2</a>
]]></um:a>
</um:r>
<link href="http://services.unimarketing.com.cn/message/注册激活" rel="alternate"></link>
<link href="http://services.unimarketing.com.cn/list/注册列表" rel="alternate"></link>
</entry>
返回结果
<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:um="http://www.unimarketing.com.cn/xmlns/">
<link href="http://services.unimarketing.com.cn/envelope/2201203000012436" rel="related" um:recipient="dejian.liu@unimarketing.com.cn" um:status="queued"></link>
<link href="http://services.unimarketing.com.cn/schedule/10850" rel="related"></link>
<link href="http://services.unimarketing.com.cn/message/10850" rel="related"></link>
</entry>
字段说明
| 字段名称 | 意义 | 数据类型 | 备注 |
|---|---|---|---|
| link | 联系人相关信息 | String |
href ="http://services.unimarketing.com.cn/envelope2201203000012436" 为 联系人ID um:recipient =联系人Email地址 um:status = 联系人状态 |
| link | 发送计划ID | String | http://services.unimarketing.com.cn/schedule/10850 |
| link | 发送邮件id | String | http://services.unimarketing.com.cn/message/9996 |
调用示例(Java 示例)
package cn.unisoftware.api.client.example.transaction;
import java.util.List;
import org.apache.commons.lang.builder.ToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;
import org.apache.log4j.Logger;
import cn.unisoftware.api.client.UnimailClient;
import cn.unisoftware.api.client.model.MessageSendReq;
import cn.unisoftware.api.client.model.TransactionMailRes;
import cn.unisoftware.api.client.utils.AtomConstants;
/**
* @description 独立发送邮件
*/
public class MessageSend {
public static void main(String[] args) throws Exception {
UnimailClient unimailClient = UnimailClient.getClient(false,UnimailClient.AuthMode.BASIC, new String[]{AtomConstants.userName,AtomConstants.userPwd});
// UnimailClient unimailClient = UnimailClient.getClient(false,ApiClient.AuthMode.APIKEY, new String[]{AtomConstants.apikey,AtomConstants.apisecret});
// UnimailClient unimailClient = UnimailClient.getClient(UnimailClient.AuthMode.APIKEY, new String[]{AtomConstants.apikey,AtomConstants.apisecret});
MessageSendReq msr = new MessageSendReq();
msr.setSubject("发送测试");
msr.setFrom("unimail2012@163.com"); // 【选填】 from 地址
msr.setReply("unimail2012@163.com"); //【选填】回复地址
msr.setListName("API测试"); //【必填】列表名称
msr.setContent("<html><body>hello world !</body></html>");//邮件内容
msr.setContentType("html");//邮件类型
msr.setTo("test@126.com");//收件人
msr.setMessageName("发送测试");//邮件名称
List<TransactionMailRes> trsLists = unimailClient.messageSend(msr);
if (trsLists != null) {
for (TransactionMailRes transactionMailRes : trsLists) {
System.out.println(ToStringBuilder.reflectionToString(transactionMailRes,ToStringStyle.MULTI_LINE_STYLE));
}
}
}
}