/contact
目录 |
/contact
- 添加多笔联系人
URL
- {HOST}/services /contact
支持格式
- XML(Atom)
HTTP 请求方式
- POST
认证方式
请求数限制
- true
请求参数
字段名称 | 是否必选 | 字段类型 | 说明 |
---|---|---|---|
auth | 是 | String | BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种 |
alt | 是 | String | 通过该参数,你可以改变返回值的格式,目前支持的返回值格式包括:atom(默认) ,暂不支持json |
是 | String | 联系人Email 地址 | |
um:type | 是 | html/text | 联系人接收邮件类别 |
um:status | 是 | String |
联系人状态 deleted=已删除 not_confirmed=未确认 activity=活动 unsubscribed=退订 invalid=无效 |
um:attribute | 否 | String | 联系人属性 |
link | 否 | String | 将联系人添加到某个列表 |
请求字符串
<?xml version="1.0" encoding="UTF-8"?> <feed xmlns="http://www.w3.org/2005/Atom"> <entry xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <email>unimail2011@163.com</email> <title></title> <um:type>html</um:type> <um:status>activity</um:status> <um:attribute name="Name" type="text">zhangshan</um:attribute> <um:attribute name="Mobile" type="text">15110087006</um:attribute> <link href="http://services.unimarketing.com.cn/list/7137" rel="related"></link> </entry> <entry xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <email>dejian.liu@unimarketing.com.cn</email> <title>DJ</title> <um:type>html</um:type> <um:status>activity</um:status> <link href="http://services.unimarketing.com.cn/list/7137" rel="related"></link> </entry> </feed>
返回结果
<?xml version="1.0" encoding="UTF-8"?> <feed xmlns="http://www.w3.org/2005/Atom"> <entry xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <id>http://services.unimarketing.com.cn/contact/10180327</id> <email>unimail2011@163.com</email> <title type="text"></title> <um:status>activity</um:status> </entry> <entry xmlns:um="http://www.unimarketing.com.cn/xmlns/"> <id>http://services.unimarketing.com.cn/contact/10180328</id> <email>dejian.liu@unimarketing.com.cn</email> <title type="text">DJ</title> <um:status>activity</um:status> </entry> </feed>
字段说明
字段名称 | 意义 | 数据类型 | 备注 |
---|---|---|---|
id | 联系人ID | Number |
http://services.unimarketing.com.cn/contact/10180327 10180327 为联系人ID |
联系人Email地址 | String | ||
um:status | 联系人状态 | String |
deleted=已删除 not_confirmed=未确认 activity=活动 unsubscribed=退订 invalid=无效 |
调用示例(Java 示例)
package cn.unisoftware.api.client.example.contact; import java.util.ArrayList; import java.util.List; import org.apache.commons.lang.builder.ToStringBuilder; import org.apache.commons.lang.builder.ToStringStyle; import cn.unisoftware.api.client.UnimailClient; import cn.unisoftware.api.client.model.ContactAttr; import cn.unisoftware.api.client.model.ContactFieldEnum; import cn.unisoftware.api.client.model.ContactReq; import cn.unisoftware.api.client.model.ContactRes; import cn.unisoftware.api.client.model.ContactStatusEnum; import cn.unisoftware.api.client.model.OptEnum; import cn.unisoftware.api.client.utils.AtomConstants; /** * @description 添加多笔联系人信息 * @author DJ * @test 【true】 */ public class AddContacts { public static void main(String[] args) throws Exception { UnimailClient unimailClient = UnimailClient.getClient(false, UnimailClient.AuthMode.BASIC, new String[] {AtomConstants.userName, AtomConstants.userPwd }); Long listId = Long.valueOf(7137); ListlistIds = new ArrayList (); listIds.add(listId); List<ContactReq> lists = new ArrayList<ContactReq>(); ContactReq cr = new ContactReq(); cr.setEmail("unimail2011@163.com"); //【必填】 // cr.setName("张三");//【必填】 cr.setType("html"); //默认 html 【选填】 cr.setStatus(ContactStatusEnum.ACTIVE); //【选填】 // cr.setListId(listId); //【选填】(如果不填该联系人将不加入任何列表) cr.setListIds(listIds); cr.setListOpt(OptEnum.RELATED);// 默认RELATED 【选填】指该操作将添加到该联系人列表中, 如果是 ALTERNATE,表示将该联系人从该列表中删除 List<ContactAttr> attrs = new ArrayList<ContactAttr>(); //【选填】 联系人属性(根据自己需要增加属性字段) ContactAttr ca = new ContactAttr(); ca.setNameAttr(ContactFieldEnum.NAME.getCodeEn()); ca.setTypeAttr(ContactFieldEnum.NAME.getCodeType()); ca.setValue("zhangshan"); attrs.add(ca); ca = new ContactAttr(); ca.setNameAttr(ContactFieldEnum.MOBILE.getCodeEn()); ca.setTypeAttr(ContactFieldEnum.MOBILE.getCodeType()); ca.setValue("15110087006"); attrs.add(ca); cr.setContactAttrs(attrs); lists.add(cr); //加入集合 cr = new ContactReq(); cr.setEmail("dejian.liu@unimarketing.com.cn"); //【必填】 cr.setStatus(ContactStatusEnum.ACTIVE); cr.setName("DJ");//【必填】 lists.add(cr); cr.setListId(listId); List<ContactRes> listRes = unimailClient.addContacts(lists); for (ContactRes res : listRes) { System.out.println(ToStringBuilder.reflectionToString(res,ToStringStyle.MULTI_LINE_STYLE)); } } }