/contactimport
目录 |
/contactimport
- 创建导入任务
URL
- {HOST}/services /contactimport
支持格式
- XML(Atom)
HTTP 请求方式
- POST
认证方式
请求数限制
- true
请求参数
| 是否必选 | 类型及范围 | 说明 | |
|---|---|---|---|
| auth | true | String | BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种 |
| alt | true | String | 通过该参数，你可以改变返回值的格式，目前支持的返回值格式包括：atom(默认) ，暂不支持json |
请求字符串
<?xml version="1.0" encoding="GBK"?> <entry xmlns="http://www.w3.org/2005/Atom" xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <title>DJ测试创建导入任务</title> <um:type>UpdateExistsAddNew</um:type> <link href="http://services.unimarketing.com.cn/list/5158" rel="related"></link> <um:reportOpen>true</um:reportOpen> <um:reportEmail>beipiao83@163.com</um:reportEmail> <um:importMethod>api</um:importMethod> <um:status>building</um:status> </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/contactimport/6156</id>
<title type="text">DJ测试创建导入任务</title>
<updated>2011-04-21T06:46:02.159Z</updated>
<um:reportOpen>true</um:reportOpen>
<um:reportEmail>beipiao83@163.com</um:reportEmail>
<um:status>building</um:status>
<um:total>0</um:total>
</entry>
字段说明
| 名称 | 意义 | 数据类型 | 备注 |
|---|---|---|---|
| title | 导入任务名称 | 字符 | |
| um:type | 处理类型 | 字符 |
UpdateExistsAddNew 更新已有的，添加新的联系人
OnlyAddNew仅添加新的联系人 OnlyUpdateExists仅更新已有的联系人 UnsubscribeExists退订已有的联系人 DeleteExists 删除已有的联系人 |
| um:importMethod | 导入方式 | 字符 |
csv:csv文件导入
txt:文本文件 xls:excel 导入 input:手工录入 api:应用接口 |
| <link href="http://services.unimarketing.com.cn/list/{listID}" res="related"/> | 添加到的列表ID | 数字 | |
| <link href="http://services.unimarketing.com.cn/list/{listID}" res="alternate"/> | 从列表中删除ID | 数字 | |
| um:reportOpen | 发送导入报告 | 布尔 |
true 发送导入报告
false 不发送导入报告 默认false; |
| um:reportEmail | 导入报告通知邮件地址 | 字符 | |
| um:total | 导入任务联系人的总数 | 数字 | |
| um:status | 导入任务的状态 | 字符 |
building：创建中
waiting:等待中 queueing：排队中 exeucting：执行中 execute_succeed:导入成功 execute_failure：执行失败 execute_stop：执行任务取消 |
| um:validNum | 有效数量 | 数字 | |
| um:inValidNum | 无效数量 | 数字 | |
| um:addToListSuccessNum | 成功数量 | 数字 | |
| um:validateHandlerNum | 处理完成数 | 数字 | |
| um:addSuccessNum | 添加成功 | 数字 | |
| um:updateSuccessNum | 跟新成功 | 数字 | |
| um:breakImportRule | 违法导入规则（20%） | 布尔 |
true :违反
false;不违反 |
| um:addToTempNum | 添加到临时列表数量 | 数字 | |
| <link href="http://www.unimarketing.com.cn/contact/{email}" /> | 通知系统用户（邮件地址） | 字符 |
调用示例(Java 示例)
package cn.unisoftware.api.client.example.contact;
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;
/**
* 创建导入任务
*
* @author DJ
* @test 【true】
*/
public class CreateImportTask {
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("DJ测试创建导入任务");
entry.addExtension(AtomConstants.QName_UM_TYPE).setText(
"UpdateExistsAddNew");
entry.addLink("http://services.unimarketing.com.cn/list/5158").setRel(
"related");
// entry.addLink("http://services.unimarketing.com.cn/list/5158").setRel(
// "alternate");
entry.addExtension(AtomConstants.QNAME_UM_REPORTOPEN).setText("true");
entry.addExtension(AtomConstants.QNAME_UM_REPORTEMAIL).setText("beipiao83@163.com");
entry.addExtension(AtomConstants.QNAME_UM_IMPORTMETHOD).setText("api");
entry.addExtension(AtomConstants.QName_UM_STATUS).setText("building");
XmlUtil.displayEncodeXml(entry);
Entry res = apiClient.saveImportTask(entry);
XmlUtil.displayEncodeXml(res);
}
}