删除收件人

Delete Subscriber 删除收件人

通过使用HTTP DELETE接口，可以将单一收件人从所有列表，或某一单一特定列表删除.

请求数据格式

根据Email地址
请求URL参数:
参数 类型 描述
apiKey string 你的API Key, 需要认证. 必填.
email string Email. 要求以URL参数形式. 需为 URL编码的.
listId int 列表标识ID. 选填. 如指定, 收件人会从单一列表中移除. 如未指定, 收件人会从所有列表中移除.
channel string 指定删除收件人的通道. 可选值:

    • 全部
    • Email地址
    • 短信/彩信

选填. 默认为Email地址

利用email地址删除订阅用户的URL示例:

https://api.esv2.com/v2/Api/Subscribers?apiKey=YOUR_API_KEY_HERE&email=johndoe@domain.com 

https://api.esv2.com/v2/Api/Subscribers?apiKey=YOUR_API_KEY_HERE&email=johndoe@domain.com&listId=1
https://api.esv2.com/v2/Api/Subscribers?apiKey=YOUR_API_KEY_HERE&email=johndoe@domain.com&channel=SmsMms

请注意，收件人Email是一个参数，不是路径的一部分

根据收件人ID

请求URL参数:
参数 类型 描述
apiKey string 你的API Key, 需要认证. 必填.
ID int 收件人 ID. 要求以路径一部分的形式应用 (非参数). 见下例
listId int 列表标识ID. 选填. 如指定, 收件人会从单一列表中移除. 如未指定, 收件人会从所有列表中移除.
channel string 指定删除收件人的通道. 可选值:

    • 全部
    • Email地址
    • 短信/彩信

选填. 默认为全部

利用收件人ID删除收件人的URL示例:

https://api.esv2.com/v2/Api/Subscribers/123?apiKey=YOUR_API_KEY_HERE
https://api.esv2.com/v2/Api/Subscribers/123?apiKey=YOUR_API_KEY_HERE&listId=1
https://api.esv2.com/v2/Api/Subscribers/123?apiKey=YOUR_API_KEY_HERE&listId=1&channel=Email

请注意，收件人ID是URL路径的一部分，不是一个参数！

根据收件人电话号码

请求URL参数:
参数 类型 描述
apiKey string 你的API Key, 需要认证. 必填.
phone string 收件人电话号码 要求以URL参数形式. 需为 URL编码的.
listId int 列表标识ID. 选填. 如指定, 收件人会从单一列表中移除. 如未指定, 收件人会从所有列表中移除.
channel string 指定删除收件人的通道. 可选值:

    • 全部
    • Email地址
    • 短信/彩信

选填. 默认为Email地址

利用电话号码订阅用户的URL示例:

https://api.esv2.com/v2/Api/Subscribers?apiKey=YOUR_API_KEY_HERE&phone=48501223344 

https://api.esv2.com/v2/Api/Subscribers?apiKey=YOUR_API_KEY_HERE&phone=48501223344&listId=1
https://api.esv2.com/v2/Api/Subscribers?apiKey=YOUR_API_KEY_HERE&phone=48501223344&channel=All

请注意，收件人电话号码是一个参数，不是路径的一部分

根据收件人标识ID

请求URL参数:
参数 类型 描述
apiKey string 你的API Key, 需要认证. 必填.
customSubscriberId string 收件人标识ID. 要求以URL参数形式. 需为 URL编码的.
listId int 列表标识ID. 选填. 如指定, 收件人会从单一列表中移除. 如未指定, 收件人会从所有列表中移除.
channel string 指定删除收件人的通道. 可选值:

    • 全部
    • Email地址
    • 短信/彩信

选填. 默认值为全部

利用收件人标识ID删除订阅用户的URL示例

https://api.esv2.com/v2/Api/Subscribers?apiKey=YOUR_API_KEY_HERE&customSubscriberId=sub_123 

https://api.esv2.com/v2/Api/Subscribers?apiKey=YOUR_API_KEY_HERE&customSubscriberId=sub_123&listId=1
https://api.esv2.com/v2/Api/Subscribers?apiKey=YOUR_API_KEY_HERE&customSubscriberId=sub_123&channel=Email

请注意，收件人标识ID是一个参数，不是路径的一部分

示例

请求:
DELETE https://api.esv2.com/v2/Api/Subscribers?apiKey=test_api_key1&email=john%40yahoo.com HTTP/1.1 

Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com
OK应答
HTTP/1.1 204 No Content
Cache-Control: private
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=2ahrqf45zbbxc3njap11i155; path=/; HttpOnly
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 07 Jul 2017 15:56:14 GMT
错误应答
HTTP/1.1 404 Not Found
Cache-Control: private
Content-Type: text/xml; charset=utf-8
Server: Microsoft-IIS/7.5
Set-Cookie: ASP.NET_SessionId=uq4wknygxzgtyojyaxkl4myn; path=/; HttpOnly
X-AspNetMvc-Version: 1.0
X-AspNet-Version: 2.0.50727
X-Powered-By: ASP.NET
Date: Wed, 07 Jul 2017 16:11:18 GMT
Content-Length: 264

<ApiResponse xmlns:xsi=”http://www.w3.org/2001/XMLSchema-instance” xmlns:xsd=”http://www.w3.org/2001/XMLSchema”>
 <ErrorMessage>
  <Code>404</Code>
  <Message>Subscriber with email – john@yahoo.com – not found.</Message>
 </ErrorMessage>
</ApiResponse>