添加到禁止列表

Add to suppression list 添加到禁止列表

利用指定ID参数将单一邮箱条目添加进禁止列表. 请求成功申请返回“201 – Created”HTTP码和空应答.

请求URL参数:

参数 类型 描述
apiKey string API Key,需要验证.必填.
ID int 禁止列表 ID. 要求以地址一部分的形式应用 (不是 GET 参数). 见下例.
entry string 邮箱条目添加至指定禁止列表.一个有效的条目可以是:

邮件地址, 如: username@domain.com
域名, 如: domain.com
MD5, 如: 2c2ba4dc950fd1162c47b08fdcfabe24
电话, 如: 48501202365
拨号前缀, 如48

必填.

entryType string 指定添加到电话号码类型禁止列表的条目电话号码或者拨号前缀(当为电子邮件类型禁止列表提供时忽略此参数)有效值为:

电话号码
拨号前缀选填
默认值为电话

这种方法会忽略禁止列表上的重复值. 当再次添加已存在于禁止列表中的电邮地址(或域名,MD5)时, 不会收到报错信息.
但发送到无效的或空邮箱条目时, 仍然会出现报错信息.

URL示例:

https://api.esv2.com/v2/Api/SuppressionLists/123?apiKey=YOUR_API_KEY_HERE&entry=username%40domain.com 

https://api.esv2.com/v2/Api/SuppressionLists/123?apiKey=YOUR_API_KEY_HERE&entry=2c2ba4dc950fd1162c47b08fdcfabe24
https://api.esv2.com/v2/Api/SuppressionLists/456?apiKey=YOUR_API_KEY_HERE&entryType=prefix&entry=48

示例

请求:
POST https://api.esv2.com/v2/Api/SuppressionLists/123?apiKey=test_api_key1&entry=username40domain.com HTTP/1.1 

Accept-Encoding: gzip,deflate 
Content-Type: application/x-www-form-urlencoded 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: localapi 
Content-Length: 0
OK应答:
HTTP/1.1 201 Created
Cache-Control: private
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 2.0.50727
Set-Cookie: TIMEZONE=Central European Standard Time; path=/
X-Powered-By: ASP.NET
Date: Wed, 19 Oct 2011 12:10:34 GMT
Content-Length: 0
错误应答:
HTTP/1.1 400 Bad Request
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
X-AspNetMvc-Version: 2.0
X-AspNet-Version: 2.0.50727
Set-Cookie: TIMEZONE=Central European Standard Time; path=/
X-Powered-By: ASP.NET
Date: Wed, 19 Oct 2011 12:12:36 GMT
Content-Length: 271

<ApiResponse xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
<ErrorMessage>
<Code>400</Code>
<Message>Entry is not a valid email, domain or MD5.</Message>
</ErrorMessage>
</ApiResponse>