/schedule/{scheduleID}
目录 |
/schedule/{scheduleID}
- 更改发送任务
URL
- {HOST}/services /schedule/{scheduleID}
支持格式
- XML(Atom)
HTTP 请求方式
- POST
认证方式
请求数限制
- true
请求参数
| 字段名称 | 是否必选 | 字段类型 | 说明 |
|---|---|---|---|
| auth | 是 | String | BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种 |
| alt | 是 | String | 通过该参数,你可以改变返回值的格式,目前支持的返回值格式包括:atom(默认) ,暂不支持json |
| title | 发送任务名称 | 字符串 | |
| um:subject | 邮件主题 | 字符串 | 需要将“<”转义为& lt; “>”转义为& gt; |
| um:from | 发送人姓名与邮件地址 | 字符串 | 格式 xxx< yyy@163.com > |
| um:from | 发送人姓名与邮件地址 | 字符串 | |
| um:reply | 回复地址 | 字符串 | |
| um:triggerMethod | 触发方式 | 字符串 | time:时间触发 |
| um:triggerCondition | 发送条件 | 字符串 | Immediately:立即发送(如是立即发送,不需要发送时间) |
| um:startupTime | 发送时间 | 字符串 | 格式:yyyy-MM-dd HH:mm:ss |
| um:optimizePolicy | 启用邮件主题优化策略 | 字符串 | auto:启用自动优化策略 |
| um:analyticsPolicy | 是否生成Google分析跟踪 | 字符串 |
GA(OnlyGenerateTrackingURLs): 启用Google分析仅在邮件中生成跟踪链接; GA(BuiltinAccount): 集成系统内置Google分析帐户数据及在邮件中生成跟踪链接; GA(AuthenticatedAccount): 用户授权系统获取其Google分析帐户数据并在邮件中生成跟踪链接 |
| um:domainScope | 跟踪链接的域名 | 字符串 | 指定邮件中链接的跟踪域名 |
| um:sendType | 发送类型(发送系统系统邮件) | 字符串 |
normal计划邮件(缺省值) system系统邮件(只能发送一封) trigger 触发邮件(暂不实现), 可以发送多封,触发条件通过联系人细分实现,这里可以传递细分id 触发的联系人和细分的id只能有一个,避免发送重复的邮件。 |
| <link href=" http://www.unimarketing.com.cn/contact/{email}" rel="alternate" /> | email 系统邮件的收件人 | 字符串 |
请求字符串
<?xml version="1.0" encoding="GBK"?> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <title>本月周三4月13日15:14:24发送</title> <um:subject>2010年8月编程书刊</um:subject> <um:from>DJ<unimail2012@163.com></um:from> <um:reply>beipiao83@163.com</um:reply> <um:triggerMethod>time</um:triggerMethod> <um:triggerCondition>immediately</um:triggerCondition> <um:startupTime>2011-05-20 15:14:24</um:startupTime> <um:optimizePolicy>auto</um:optimizePolicy> <um:analyticsPolicy>GA(OnlyGenerateTrackingURLs)</um:analyticsPolicy> <um:domainScope>http://beijing.piaowu.com.cn</um:domainScope> <um:domainScope>http://tianjing.piaowu.com.cn</um:domainScope> <link href="http://services.unimarketing.com.cn/message/9989" rel="related"></link> <link href="http://services.unimarketing.com.cn/list/5072" rel="related"></link> <link href="http://services.unimarketing.com.cn/list/5093" rel="related"></link> <um:sendType>system</um:sendType> <link href="http://127.0.0.1:8080/uniapi/services/contact/unimail2012@163.com" rel="alternate"></link> </entry>
返回结果
<?xml version="1.0" encoding="GBK"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:um="http://www.unimarketing.com.cn/xmlns/">
<id>http://services.unimarketing.com.cn/schedule/6607</id>
<um:messageName>我的测试DJ</um:messageName>
<um:startupTime>2011-04-20 11:10:25</um:startupTime>
</entry>
字段说明
| 字段名称 | 意义 | 数据类型 | 备注 |
|---|---|---|---|
| id | 发送计划ID | Number | |
| um:messageName | 邮件名称 | String | |
| um:startupTime | 开始发送时间 | String |
调用示例(Java 示例)
package cn.unisoftware.api.client.example.sendTask;
import org.apache.abdera.Abdera;
import org.apache.abdera.model.Entry;
import cn.unisoftware.api.client.ApiClient;
import cn.unisoftware.api.client.utils.AtomConstants;
import cn.unisoftware.api.client.utils.XmlUtil;
/**
* @description 更改发送任务
* @author DJ
* @test 【true】
*/
public class UpdateSendTask {
/**
* @param args
* @throws Exception
*/
public static void main(String[] args) throws Exception {
ApiClient apiClient = ApiClient.getApiClient(false,ApiClient.AuthMode.APIKEY, new String[]{AtomConstants.apikey,AtomConstants.apisecret});
Abdera abdera = Abdera.getInstance();
Entry entry = abdera.newEntry();
entry.addExtension(AtomConstants.TITLE).setText("本月周三4月13日15:14:24发送");
entry.addExtension(AtomConstants.QName_UM_SUBJECT).setText("2010年8月编程书刊");
entry.addExtension(AtomConstants.QName_UM_FROM).setText("DJ");
entry.addExtension(AtomConstants.QName_UM_REPLY).setText("beipiao83@163.com");
entry.addExtension(AtomConstants.QName_UM_TRIGGERMETHOD).setText("time");
entry.addExtension(AtomConstants.QName_UM_TRIGGERCONDITION).setText("immediately");
entry.addExtension(AtomConstants.QName_UM_STARTUPTIME).setText("2011-05-20 15:14:24");
entry.addExtension(AtomConstants.QNAME_UM_OPTIMIZEPOLICY).setText("auto");
entry.addExtension(AtomConstants.QName_UM_ANALYTICSPOLICY).setText("GA(OnlyGenerateTrackingURLs)");
entry.addExtension(AtomConstants.QName_UM_DOMAINSCOPE).setText("http://beijing.piaowu.com.cn");
entry.addExtension(AtomConstants.QName_UM_DOMAINSCOPE).setText("http://tianjing.piaowu.com.cn");
/**
* 需要发送的邮件
*/
entry.addLink("http://services.unimarketing.com.cn/message/9989").setAttributeValue("rel", "related");
/**
* 表示需要跟那个邮件列表用户发送
*/
entry.addLink("http://services.unimarketing.com.cn/list/5072").setAttributeValue("rel", "related");
entry.addLink("http://services.unimarketing.com.cn/list/5093").setAttributeValue("rel", "related");
entry.addExtension(AtomConstants.QNAME_UM_SENDTYPE).setText("system");
/**
* (目前只支持一个收邮件联系人)
*/
// entry.addLink("http://www.unimarketing.com.cn/contact/beipiao83@163.com").setAttributeValue("rel", "alternate");
entry.addLink("http://127.0.0.1:8080/uniapi/services/contact/unimail2012@163.com").setAttributeValue("rel", "alternate");
String scheduleId = "6607"; //根据查询所得
XmlUtil.displayEncodeXml(entry);
Entry res = apiClient.updateSendTask(entry, scheduleId);
XmlUtil.displayEncodeXml(res);
}
}