/contactimport
目录 |
/contactimport
- 导入联系人
URL
- POST {HOST}/services /contactimport/import/{importID}
支持格式
- XML(Atom)
HTTP 请求方式
- PUT / POST
认证方式
请求数限制
- true
请求参数
字段名称 | 是否必选 | 字段类型 | 说明 |
---|---|---|---|
auth | 是 | String | BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种 |
alt | 是 | String | 通过该参数,你可以改变返回值的格式,目前支持的返回值格式包括:atom(默认) ,暂不支持json |
是 | String | 联系人Email地址 | |
um:attribute | 否 | String | 联系人属性(可以是系统默认的,也可以是用户自定义的联系人属性(需要用户预先创建好)) |
请求字符串
<feed xmlns="http://www.w3.org/2005/Atom"> <link href="http://services.unimarketing.com.cn/contactimport/6156" rel="related"></link> <entry xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <email>liudejian@gmail.com</email> <um:attribute name="Name">张三</um:attribute> </entry> <entry xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <email>unimail2012@163.com</email> <um:attribute name="Name">李四</um:attribute> </entry> <entry xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <email>dj@123.com</email> <um:attribute name="Name">王五</um:attribute> </entry> </feed>
返回结果
<?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"></title> <um:reportOpen>true</um:reportOpen> <um:reportEmail>beipiao83@163.com</um:reportEmail> <um:status>waiting</um:status> <um:total>3</um:total> </entry>
字段说明
字段名称 | 意义 | 数据类型 | 备注 |
---|---|---|---|
id | 导入任务ID | Number | |
title | 导入任务名称 | String | |
um:reportOpen | 是否通知管理人员 | Boolean | true = 通知 | false = 不通知 |
um:reportEmail | 管理人员Email地址 | String | |
um:status | 导入状态 | String |
building = 创建中 waiting = 等待中 queueing = 排队中 exeucting = 执行中 execute_succeed = 导入成功 execute_failure = 执行失败 execute_stop = 执行任务取消 |
um:total | 已导入人数 | Number |
调用示例(Java 示例)
package cn.unisoftware.api.client.example.contact; 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 ImportContacts { /** * 执行导入任务 * @param apiClient * @param contactimportId * @throws Exception */ public static void executeImportTask(ApiClient apiClient,Integer contactimportId) throws Exception { Abdera abdera = Abdera.getInstance(); Entry entry = abdera.newEntry(); apiClient.modifyImportTask(entry, contactimportId+""); } /** * @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(); Feed feed = abdera.newFeed(); String contactimportId= "6156"; //新创建的一个导入任务,并且为buiding状态 feed.addLink("http://services.unimarketing.com.cn/contactimport/"+contactimportId).setAttributeValue("rel", "related"); Entry entry = abdera.newEntry(); entry.addExtension(AtomConstants.EMAIL).setText("liudejian@gmail.com"); // entry.addExtension(AtomConstants.TITLE).setText("张三"); // entry.addExtension(AtomConstants.QName_UM_TYPE).setText("html"); // // entry.addExtension(AtomConstants.QName_UM_STATUS).setText("activity"); // entry.addExtension(AtomConstants.QName_UM_ATTRIBUTE).setAttributeValue("name", "phone").setAttributeValue("type", "text") // .setText("010-15110087001"); //因为属性中不存在 phone // entry.addExtension(AtomConstants.QName_UM_ATTRIBUTE).setAttributeValue("name", "title").setAttributeValue("type", "text") // .setText("技术工程师"); entry.addExtension(AtomConstants.QName_UM_ATTRIBUTE).setAttributeValue("name", "Name").setText("张三"); feed.addEntry(entry); Entry contact2 = feed.addEntry(); contact2.addExtension(AtomConstants.EMAIL).setText("unimail2012@163.com"); contact2.addExtension(AtomConstants.QName_UM_ATTRIBUTE).setAttributeValue("name", "Name").setText("李四"); Entry contact3 = feed.addEntry(); contact3.addExtension(AtomConstants.EMAIL).setText("dj@123.com"); contact3.addExtension(AtomConstants.QName_UM_ATTRIBUTE).setAttributeValue("name", "Name").setText("王五"); XmlUtil.displayEncodeXml(feed); Entry res = apiClient.importContacts(feed); XmlUtil.displayEncodeXml(res); executeImportTask(apiClient,contactimportId); } }