灵动创新 Unimarketing 邮件营销 EDM

/schedule/query?start-index=1&max-results=10

目录

/schedule/query?start-index=1&max-results=10

  • 查询发送任务

URL

  • {HOST}/services /schedule/query?start-index=1&max-results=10

支持格式

  • XML(Atom)

HTTP 请求方式

  • POST

认证方式

请求数限制

  • true

请求参数

字段名称 是否必选 字段类型 说明
auth 是 String BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种
alt 是 String 通过该参数，你可以改变返回值的格式，目前支持的返回值格式包括：atom(默认) ，暂不支持json
start-index true int 从第几条记录开始
max-results true int 查询返回最大记录数
um:name 否 String 发送计划名称 (模糊查询)
um:mail 否 String 邮件名称(模糊查询)

请求字符串 

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:um="http://www.unimarketing.com.cn/xmlns/">
  <um:name></um:name>
  <um:mail></um:mail>
</entry>

返回结果 

 <?xml version="1.0" encoding="GBK"?>
<feed xmlns="http://www.w3.org/2005/Atom" xmlns:gd="http://schemas.google.com/g/2005" xmlns:um="http://www.unimarketing.com.cn/xmlns/" xmlns:openSearch="http://a9.com/-/spec/opensearchrss/1.0/">
  <openSearch:itemsPerPage>5</openSearch:itemsPerPage>
  <openSearch:startIndex>1</openSearch:startIndex>
  <openSearch:totalResults>3</openSearch:totalResults>
  <entry>
    <id>http://services.unimarketing.com.cn/schedule/7110</id>
    <title type="text">DJ_MY_GOD_OOK</title>
    <link href="http://services.unimarketing.com.cn/schedule/7110" rel="self"></link>
    <link href="http://services.unimarketing.com.cn/schedule/DJ_MY_GOD_OOK" rel="alternate"></link>
    <um:messageName>我的测试DJ</um:messageName>
    <um:subject>2010?8?????</um:subject>
    <um:from>DJ&lt;unimail2012@163.com&gt;</um:from>
    <um:reply>unimail2012@163.com</um:reply>
    <um:triggerMethod>time</um:triggerMethod>
    <um:triggerCondition></um:triggerCondition>
    <um:startupTime>2011-05-12 17:14:24</um:startupTime>
    <um:status>completed</um:status>
    <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/5093" rel="related"></link>
    <link href="http://services.unimarketing.com.cn/list/5072" rel="related"></link>
  </entry>
  <entry>
    <id>http://services.unimarketing.com.cn/schedule/7111</id>
    <title type="text">DJ_MY_GOD_OOK</title>
    <link href="http://services.unimarketing.com.cn/schedule/7111" rel="self"></link>
    <link href="http://services.unimarketing.com.cn/schedule/DJ_MY_GOD_OOK" rel="alternate"></link>
    <um:messageName>我的测试DJ</um:messageName>
    <um:subject>2010年8月编程书刊</um:subject>
    <um:from>DJ&lt;unimail2012@163.com&gt;</um:from>
    <um:reply>unimail2012@163.com</um:reply>
    <um:triggerMethod>time</um:triggerMethod>
    <um:triggerCondition></um:triggerCondition>
    <um:startupTime>2011-04-13 17:14:24</um:startupTime>
    <um:status>completed</um:status>
    <um:optimizePolicy>auto</um:optimizePolicy>
    <um:analyticsPolicy>GA(OnlyGenerateTrackingURLs)</um:analyticsPolicy>
    <um:domainScope>http://tianjing.piaowu.com.cn</um:domainScope>
    <um:domainScope>http://beijing.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/5093" rel="related"></link>
    <link href="http://services.unimarketing.com.cn/list/5072" rel="related"></link>
  </entry>
  <entry>
    <id>http://services.unimarketing.com.cn/schedule/7112</id>
    <title type="text">DJ_MY_GOD_OOK</title>
    <link href="http://services.unimarketing.com.cn/schedule/7112" rel="self"></link>
    <link href="http://services.unimarketing.com.cn/schedule/DJ_MY_GOD_OOK" rel="alternate"></link>
    <um:messageName>我的测试DJ</um:messageName>
    <um:subject>2010年8月编程书刊</um:subject>
    <um:from>DJ&lt;unimail2012@163.com&gt;</um:from>
    <um:reply>unimail2012@163.com</um:reply>
    <um:triggerMethod>time</um:triggerMethod>
    <um:triggerCondition></um:triggerCondition>
    <um:startupTime>2011-05-16 17:14:24</um:startupTime>
    <um:status>completed</um:status>
    <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>
  </entry>
</feed>

字段说明

字段名称 意义 数据类型 备注
id 发送计划ID Number
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:status 发送计划状态 字符串 queued     排队     0
pushing     正在推送     1
pushed     已推完     2
canceled     取消     3
failure     发送失败     4
abnormality     数据异常     5
waitting     等待发送     6
created     邮件已创建     7
creating     邮件正在创建     8
messagesQuotaReached     需要付费     9
completed     已发送     F
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 系统邮件的收件人 字符串

调用示例(Java 示例) 

  
package cn.unisoftware.api.client.example.sendTask;

import java.util.concurrent.ConcurrentHashMap;

import org.apache.abdera.Abdera;
import org.apache.abdera.model.Entry;
import org.apache.abdera.model.Feed;

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 QuerySendTask {
 
	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();
		ConcurrentHashMap queryMap = new ConcurrentHashMap();
		queryMap.put("start-index", "1");
		queryMap.put("max-results", "5");
		entry.addExtension(AtomConstants.QName_UM_NAME).setText("DJ_MY_GOD_OOK");
		XmlUtil.displayEncodeXml(entry);
		Feed feed = apiClient.querySendTask(entry, queryMap);
		XmlUtil.displayEncodeXml(feed);
	}
}
平台介绍
关于我们 | 联系我们 | 行业应用 | 专业术语 | 资源中心 | 隐私声明
© 2005-2024 灵动创新（北京）科技有限公司 - 京ICP备16028763号-1