灵动创新 Unimarketing 邮件营销 EDM

/contactimport/{importID}

目录

/contactimport/{importID}

  • 查询导入任务

URL

  • {HOST}/services /contactimport/{importID}

支持格式

  • XML(Atom)

HTTP 请求方式

  • GET

认证方式

请求数限制

  • true

请求参数

字段名称 是否必选 字段类型 说明
auth String BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种
alt String 通过该参数,你可以改变返回值的格式,目前支持的返回值格式包括:atom(默认) ,暂不支持json
importTaskId true String 导入任务ID

请求字符串

返回结果

<?xml version="1.0" encoding="UTF-8"?>
<entry xmlns="http://www.w3.org/2005/Atom" xmlns:um="http://www.unimarketing.com.cn/xmlns/">
  <id>http://services.unimarketing.com.cn/contactimport/7678</id>
  <um:importMethod>api</um:importMethod>
  <um:type>OnlyUpdateExists</um:type>
  <link href="http://services.unimarketing.com.cn/list/5158" rel="related"></link>
  <link href="http://services.unimarketing.com.cn/list/5159" rel="alternate"></link>
  <um:total>5</um:total>
  <um:status>execute_succeed</um:status>
  <um:validNum>1</um:validNum>
  <um:inValidNum>4</um:inValidNum>
  <um:addToListSuccessNum>0</um:addToListSuccessNum>
  <um:validateHandlerNum>0</um:validateHandlerNum>
  <um:addSuccessNum>0</um:addSuccessNum>
  <um:updateSuccessNum>0</um:updateSuccessNum>
  <um:breakImportRule>false</um:breakImportRule>
  <um:addToTempNum>0</um:addToTempNum>
  <link href="http://127.0.0.1:8080/uniapi/services/contact/unimail2011@163.com" rel="alternate"></link>
</entry>                        
                           

字段说明

字段名称 意义 数据类型 备注
id 导入任务ID Number
um:type 处理类型 String UpdateExistsAddNew 更新已有的,添加新的联系人
OnlyAddNew仅添加新的联系人
OnlyUpdateExists仅更新已有的联系人
UnsubscribeExists退订已有的联系人
DeleteExists 删除已有的联系人
um:importMethod 导入方式 String csv:csv文件导入
txt:文本文件
xls:excel 导入
input:手工录入
api:应用接口
<link href="http://services.unimarketing.com.cn/list/{listID}" res="related"/> 添加到的列表ID Number
<link href="http://services.unimarketing.com.cn/list/{listID}" res="alternate"/> 从列表中删除ID Number
um:reportOpen 发送导入报告 布尔 true 发送导入报告
false 不发送导入报告
默认false;
um:reportEmail 导入报告通知邮件地址 String
um:total 导入任务联系人的总数 Number
um:status 导入任务的状态 String building:创建中
waiting:等待中
queueing:排队中
exeucting:执行中
execute_succeed:导入成功
execute_failure:执行失败
execute_stop:执行任务取消
um:validNum 有效数量 Number
um:inValidNum 无效数量 Number
um:addToListSuccessNum 成功数量 Number
um:validateHandlerNum 处理完成数 Number
um:addSuccessNum 添加成功 Number
um:updateSuccessNum 跟新成功 Number
um:breakImportRule 违法导入规则(20%) 布尔 true :违反
false;不违反
um:addToTempNum 添加到临时列表数量 Number
<link href="http://www.unimarketing.com.cn/contact/{email}" /> 通知系统用户(邮件地址) String

调用示例(Java 示例)

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

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 【ture】 必需是导入完成的.但contactNumber 与 contactValidNumber 必需有值
 */
public class QueryImportTask {

	/**
	 * @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});
		String importID = "6156";
		Entry res = apiClient.queryImportTask(importID);
        XmlUtil.displayEncodeXml(res);
	}

}
 
平台介绍
关于我们 | 联系我们 | 行业应用 | 专业术语 | 资源中心 | 隐私声明
© 2022 灵动创新(北京)科技有限公司 - 京ICP备16028763号-1