获取休眠中收件人
Get snoozed subscribers 获取休眠中收件人
SnoozedSubscribers接口允许检索已（暂停）休眠的收件人集合. 这个集合可以通过收件人列表ID和时间范围筛选出来
请求数据格式
请求URL 参数:
| 参数 | 类型 | 描述 |
|---|---|---|
| apiKey | string | 你的API Key，需要验证，必填. |
| listIds | int (CSV) | 列表标识ID. 选填. 如指定, 只有从指定列表中休眠的收件人会被返回. 如未指定, 从所有列表中休眠的收件人都会被返回. 指定多个列表ID, 用逗号隔开, 如: 12,34,56,789 |
| startDate | date | 起始日期. 选填. 如果指定, 在此日期之前休眠状态被结束的收件人不会被返回. 可以与 endDate 一同使用来定义一段时间区间.格式YYYY-MM-DD. |
| endDate | date | 见起始日期 |
| channel | string | 限定返回值为指定通道. 选填*. 默认为电子邮件. 有效值包含:
|
注意：注意只有apiKey参数是必填的。但如果忽略其他参数，你会得到一个自创建业务单元伊始，无论何时结束休眠，存在于所有列表中的休眠状态收件人的集合
|
https://api.esv2.com/v2/Api/SnoozedSubscribers?apiKey=YOUR_API_KEY_HERE
https://api.esv2.com/v2/Api/SnoozedSubscribers?apiKey=YOUR_API_KEY_HERE&listIds=1,3,16
https://api.esv2.com/v2/Api/SnoozedSubscribers?apiKey=YOUR_API_KEY_HERE&startDate=2014-03-01&endDate=2014-03-10
|
应答
| 元素/属性 | 类型 | 描述 |
|---|---|---|
| SnoozedSubscribersList | array[complex] | SnoozedSubscriber元素组成的数组. |
| 元素/属性 | 类型 | 描述 |
|---|---|---|
| string | 休眠收件人的email. | |
| Phone | string | 休眠收件人的电话号码. |
| ListId | int | 收件人从某列表休眠，该列表的标识ID. |
| SnoozedUntil | dateTime | 休眠状态结束的日期时间. |
示例
|
GET https://api.esv2.com/v2/Api/SnoozedSubscribers?apiKey=test_api_key1&channel=All HTTP/1.1
Accept-Encoding: gzip,deflate
Host: api.esv2.com
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
|
| HTTP/1.1 200 OK Cache-Control: private Content-Type: text/xml; charset=utf-8 Server: Microsoft-IIS/7.5 X-AspNetMvc-Version: 5.1 X-AspNet-Version: 4.0.30319 X-Powered-By: ASP.NET Date: Wed, 05 Mar 2014 12:16:49 GMT Content-Length: 591 <ApiResponse xmlns:xsd=”http://www.w3.org/2001/XMLSchema” xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance”> |