/contact
目录 |
/contact
- 查询联系人信息
URL
- {HOST}/services /contact
支持格式
- XML(Atom)
HTTP 请求方式
- GET
认证方式
请求数限制
- true
请求参数
| 字段名称 | 是否必选 | 字段类型 | 说明 |
|---|---|---|---|
| auth | 是 | String | BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种 |
| alt | 是 | String | 通过该参数,你可以改变返回值的格式,目前支持的返回值格式包括:atom(默认) ,暂不支持json |
| 否 | String | 联系人Email 地址 | |
| status | 否 | String |
deleted=已删除 not_confirmed=未确认 activity = 活动 unsubscribed = 退订 invalid = 无效地址 |
| listId | 否 | Number | 联系人列表ID |
请求字符串
无
返回结果
<?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>15624</openSearch:totalResults>
<title type="text">搜索 [email=null,status=2,listId=null] 结果</title>
<entry>
<id>http://services.unimarketing.com.cn/contact/5222746</id>
<link href="http://services.unimarketing.com.cn/contact/5222746" rel="self"></link>
<um:type>html</um:type>
<um:status>activity</um:status>
<um:created>2011-06-14 14:21:08</um:created>
<link href="http://services.unimarketing.com.cn/list/5160" rel="related"></link>
<link href="http://services.unimarketing.com.cn/list/技术组" rel="related"></link>
<email>aihdiao819@sina.com</email>
<um:attribute name="mz" label="名族" type="select" show="true" public="true" sn="0">苗族</um:attribute>
</entry>
<entry>
<id>http://services.unimarketing.com.cn/contact/5222745</id>
<link href="http://services.unimarketing.com.cn/contact/5222745" rel="self"></link>
<um:type>html</um:type>
<um:status>activity</um:status>
<um:created>2011-06-14 13:34:58</um:created>
<link href="http://services.unimarketing.com.cn/list/5160" rel="related"></link>
<link href="http://services.unimarketing.com.cn/list/技术组" rel="related"></link>
<email>zuiwoxing9@gmail.com</email>
<um:attribute name="Gender" label="性别" type="radio" show="true" public="true" sn="0">男</um:attribute>
<um:attribute name="mz" label="名族" type="select" show="true" public="true" sn="0">苗族</um:attribute>
</entry>
<entry>
<id>http://services.unimarketing.com.cn/contact/5222744</id>
<link href="http://services.unimarketing.com.cn/contact/5222744" rel="self"></link>
<um:type>html</um:type>
<um:status>activity</um:status>
<um:created>2011-06-14 13:26:45</um:created>
<link href="http://services.unimarketing.com.cn/list/5160" rel="related"></link>
<link href="http://services.unimarketing.com.cn/list/技术组" rel="related"></link>
<email>wo@123.com</email>
<um:attribute name="mz" label="名族" type="select" show="true" public="true" sn="0">苗族</um:attribute>
</entry>
<entry>
<id>http://services.unimarketing.com.cn/contact/5222743</id>
<updated>2011-06-14T05:17:03.000Z</updated>
<link href="http://services.unimarketing.com.cn/contact/5222743" rel="self"></link>
<um:type>html</um:type>
<um:status>activity</um:status>
<um:created>2011-06-14 13:15:59</um:created>
<link href="http://services.unimarketing.com.cn/list/5160" rel="related"></link>
<link href="http://services.unimarketing.com.cn/list/技术组" rel="related"></link>
<email>y899@163.com</email>
<um:attribute name="Gender" label="性别" type="radio" show="true" public="true" sn="0">男</um:attribute>
<um:attribute name="Name" label="姓名测试" type="text" show="true" public="true" sn="0">666</um:attribute>
</entry>
<entry>
<id>http://services.unimarketing.com.cn/contact/5222742</id>
<updated>2011-06-14T05:17:49.000Z</updated>
<link href="http://services.unimarketing.com.cn/contact/5222742" rel="self"></link>
<um:type>html</um:type>
<um:status>activity</um:status>
<um:created>2011-06-14 13:06:05</um:created>
<link href="http://services.unimarketing.com.cn/list/5160" rel="related"></link>
<link href="http://services.unimarketing.com.cn/list/技术组" rel="related"></link>
<email>zui99@gmail.com</email>
<um:attribute name="Gender" label="性别" type="radio" show="true" public="true" sn="0">男</um:attribute>
<um:attribute name="Name" label="姓名测试" type="text" show="true" public="true" sn="0">666</um:attribute>
</entry>
</feed>
字段说明
| 字段名称 | 意义 | 数据类型 | 备注 |
|---|---|---|---|
| openSearch:itemsPerPage | 每页显示几条记录 | Number | |
| openSearch:totalResults | 记录总数 | Number | |
| openSearch:startIndex | 开始页 | Number | |
| title | 查询条件 | String | |
| id / link | 联系人ID | Number | |
| updated | 更新时间 | Date | |
| um:type | 联系人接收邮件类别 | String | |
| um:status | 联系人状态 | String |
deleted=已删除 not_confirmed=未确认 activity=活动 unsubscribed=退订 invalid=无效 |
| um:created | 联系人创建时间 | String | 年-月-日 小时:分:秒 |
| 联系人Email地址 | String | ||
| um:attribute | 联系人属性 | String | |
| list/7137 | 联系人列表ID (7137 为了联系人列表ID) | Number | |
| list/技术小组 | 联系人列表名称 (技术小组 为 列表名称) | String |
调用示例(Java 示例)
package cn.unisoftware.api.client.example.contact;
import java.util.concurrent.ConcurrentHashMap;
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 QueryContacts {
/**
* GET http://services.unimarketing.com.cn/contact?q=tech&start-index=10&max-results=50
* @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});
ApiClient apiClient = ApiClient.getApiClient(false,ApiClient.AuthMode.BASIC, new String[]{AtomConstants.userName,AtomConstants.userPwd});
ConcurrentHashMap map = new ConcurrentHashMap();
// q=[email=*,status=0,listId=5289]
map.put("q", "[email=null,status=2,listId=null]");
map.put("start-index", "1");
map.put("max-results", "5");
Feed feed = apiClient.queryContacts(map);
XmlUtil.displayEncodeXml(feed);
}
}