/list?q=***&start-index=1&max-results=10
URL
-
{HOST}/services
/list?q=***&start-index=1&max-results=10
支持格式
HTTP 请求方式
认证方式
请求数限制
请求参数
字段名称 | 是否必选 | 字段类型 | 说明 |
auth | 是 | String | BASIC/APIKEY/ OAUTH 三种认证方式信息中的一种 |
alt | 是 | String | 通过该参数,你可以改变返回值的格式,目前支持的返回值格式包括:atom(默认) ,暂不支持json |
q
|
true
|
String
|
查询条件 (q=* 表示查询所有)
|
start-index
|
true
|
int
|
开始记录数
|
max-results
|
true
|
int
|
最大记录数
|
请求字符串
无
返回结果
<?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>34</openSearch:totalResults>
<title type="text">搜索 * 结果</title>
<entry>
<id>http://services.unimarketing.com.cn/list/5032</id>
<title type="text"></title>
<subtitle type="text">A</subtitle>
<um:activeCount>22</um:activeCount>
<um:unsubscribeCount>0</um:unsubscribeCount>
<um:invalidateCount>0</um:invalidateCount>
<um:unconfirmCount>0</um:unconfirmCount>
</entry>
<entry>
<id>http://services.unimarketing.com.cn/list/5033</id>
<title type="text">第一次导入1209</title>
<subtitle type="text">第一次导入1209</subtitle>
<um:activeCount>4</um:activeCount>
<um:unsubscribeCount>0</um:unsubscribeCount>
<um:invalidateCount>0</um:invalidateCount>
<um:unconfirmCount>0</um:unconfirmCount>
</entry>
<entry>
<id>http://services.unimarketing.com.cn/list/5034</id>
<title type="text">2010-12-02 16:36:21导入时通知添加的联系人</title>
<subtitle type="text">2010-12-02 16:36:21导入时通知添加的联系人</subtitle>
<um:activeCount>4</um:activeCount>
<um:unsubscribeCount>0</um:unsubscribeCount>
<um:invalidateCount>0</um:invalidateCount>
<um:unconfirmCount>0</um:unconfirmCount>
</entry>
<entry>
<id>http://services.unimarketing.com.cn/list/5035</id>
<title type="text">第三次</title>
<subtitle type="text">第三次</subtitle>
<um:activeCount>0</um:activeCount>
<um:unsubscribeCount>0</um:unsubscribeCount>
<um:invalidateCount>0</um:invalidateCount>
<um:unconfirmCount>0</um:unconfirmCount>
</entry>
<entry>
<id>http://services.unimarketing.com.cn/list/5058</id>
<title type="text">test1209列表-内</title>
<subtitle type="text">test1209列表-外</subtitle>
<um:activeCount>0</um:activeCount>
<um:unsubscribeCount>0</um:unsubscribeCount>
<um:invalidateCount>0</um:invalidateCount>
<um:unconfirmCount>0</um:unconfirmCount>
</entry>
</feed>
字段说明
字段名称 | 意义 | 数据类型 | 备注 |
openSearch:itemsPerPage
|
每页 几条记录
|
Number
|
|
openSearch:startIndex
|
开始页
|
Number
|
|
openSearch:totalResults
|
总记录数
|
Number
|
|
title
|
查询条件
|
String
|
|
id
|
列表ID
|
Number
|
http://services.unimarketing.com.cn/list/5032
5032 为列表ID
|
title(entry中的title)
|
列表名称 (内)
|
String
|
|
subtitle
|
列表名称 (外)
|
String
|
|
um:activeCount
|
活动联系人数
|
Number
|
|
um:unsubscribeCount
|
退订联系人数
|
Number
|
|
um:invalidateCount
|
无效地址
|
Number
|
|
um:unconfirmCount
|
未确认联系人数
|
Number
|
|
调用示例(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 QueryContactList {
/**
* @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});
ConcurrentHashMap<String , String> map = new ConcurrentHashMap<String
, String>();
map.put("q", "*");
map.put("start-index", "1");
map.put("max-results", "5");
Feed feed = apiClient.queryContactList(map);
XmlUtil.displayEncodeXml(feed);
}
}