添加休眠收件人
Snooze subscriber 添加休眠收件人
当某些订阅用户要求一段时间内暂时不接收邮件，但之后仍希望继续订阅时，就可以把这样的用户放入休眠列表中. 该功能保证这些用户现下不会收到邮件，但之后仍可以解除休眠，重新正常订阅. 我们可以通过API接口的HTTP POST请求实现这一功能.
假如，在操作中该用户已经休眠了，那么一条错误信息会被系统返回.
请求数据格式
Data子元素:
| 元素/属性 | 类型 | 描述 |
|---|---|---|
| ListId | integer | 被休眠用户所在的列表编号. 若未指明具体用户，该列表的所有用户都会被休眠. |
| Id | integer | （单个）休眠用户的编号. 选填* |
| string | 休眠用户邮箱. 选填* | |
| Phone | string | 收件人电话号码. 选填.* |
| CustomSubscriberId | string | 收件人标识ID. 选填.* |
| Channel | string | 收件人休眠通道类型（至少有一项需要指定: ID, 电子邮件, 电话号码, 收件人标识ID). 选填.** |
| SnoozeWeeks | integer | 休眠时长，以周为单位。有效数字是1—26 |
*用户ID, Email, 电话号码, 收件人标识ID必填一个. 如果参数多于一个系统会检查第一个有效值并忽略其他.
** 收件人休眠通道类型有不同默认参数值: 默认值为: Id – All, Email – Email; Phone – SmsMms; CustomSubscriberId – All.
示例
请求:
| POST https://api.esv2.com/v2/Api/SnoozedSubscribers HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: application/xml
Content-Length: 288
Host: api.esv2.com
Connection: Keep-Alive
User-Agent: Apache-HttpClient/4.1.1 (java 1.5)
<ApiRequest xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xs=”http://www.w3.org/2001/XMLSchema”>
<ApiKey>test_api_key1</ApiKey>
<Data>
<Email>testsnoozed1@test123.com</Email>
<ListId>101</ListId>
<SnoozeWeeks>14</SnoozeWeeks>
</Data>
</ApiRequest>
|
应答:
| HTTP/1.1 201 Created Cache-Control: private 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:33:05 GMT Content-Length: 0 |