获取弹回列表

Get bounces list 获取弹回列表

利用此接口你可以使用特定时间区间来检索弹回并得到返回的CSV。此列表包括弹回时间，弹回email地址，以及诊断代码.

请求数据格式

请求 URL 参数:

参数 类型 描述
apiKey string 你的API Key, 需要验证，必填.
startDate date 检索时间区间的起始日期. 必填.
endDate date 检索时间区间的终止日期. 必填.
channel string 返回值通道选取. 选填. 默认为邮件.有效值包括：

    • All 全部
    • Email 邮件
    • SmsMms 短信/彩信
bounceType int 限定返回数据只关于某一类型的弹回.选填.有效值包括：

    • 1 – User unknown 邮箱地址无效
    • 2 – Mailbox full 邮箱已满
    • 3 – Blocked 被阻止
    • 6 – Unknown 原因未知
    • 7 – Other 其他

示例:

https://api.esv2.com/v2/Api/Bounces?apiKey=YOUR_API_KEY_HERE&startDate=2010-05-20&endDate=2010-05-22https://api.esv2.com/v2/Api/Bounces?apiKey=YOUR_API_KEY_HERE&startDate=2010-05-20&endDate=2010-05-22&bounceType=1

应答

这种接口与其他接口不同的是，返回的数据是以CSV格式，而不是XML。这是因为这类接口的返回数据通常数量更大一些。CSV会减少管理成本，而且一般来说会更容易与第三方代码/系统无缝对接.
应答内容类型应为“text/csv”。返回的数据将包含各列名称的表头.
输出的CSV格式将遵循以下设置:
      • Field separator: comma (,)   字段分隔符：逗号 (,)
      • Quoting character: (“) 引用符
      • Escape character: (“) 换码符
      • Encoding: UTF-8 编码

CSV 应答列名称:

名称 类型 描述
Date datetime 弹回时间.格式为 YYYY-MM-DD HH:MM:SS.
Email string 弹回Email地址.
Phone string 弹回电话号码.
BounceCode string 用于诊断弹回类型的弹回诊断码.
BounceType string 弹回类型. 所有可能的弹回类型如下.

基于通道设置（邮件或短信/彩信）返回的CSV文档：

1.  All 全部 （邮件 & 短信/彩信）：

      • Date 日期
      • Email* 邮箱地址*
      • Phone* 电话*
      • BounceCode 弹回诊断码
      • BounceType 弹回类型

* 每一行仅有email地址或电话号码有取值，不可能两者兼有.

2. Email 邮件:

      • Date 日期
      • Email* 电邮地址*
      • BounceCode 弹回诊断码
      • BounceType 弹回类型

3. Phone 短信/彩信：

      • Date 日期
      • Phone 电话号码
      • BounceCode 弹回诊断码
      • BounceType 弹回类型

弹回类型 (他们中的任一会出现在 CSV文件 的BounceType列中):

名称 描述
UserUnknown Email 不存在.
MailboxFull 收件人邮箱已满或暂时无法接收.
Blocked 发送邮件受阻, 通常由于被判定为垃圾邮件等相关原因.
Unknown 不明原因.（无法分类）.
Other 其他退信原因。包括传输相关问题，邮件服务器bug等.

示例

获取多封邮件的弹回信息

请求:

GET https://api.esv2.com/v2/Api/Bounces?apiKey=test_api_key1&startDate=2010-10-01&endDate=2010-10-02&channel=Email HTTP/1.1 
Accept-Encoding: gzip,deflate 
User-Agent: Jakarta Commons-HttpClient/3.1 
Host: api.esv2.com

OK 应答:

HTTP/1.1 200 OK 
Cache-Control: private 
Content-Type: text/csv; 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: Thu, 08 Dec 2011 12:02:14 GMT 
Content-Length: 463  Date,Email,BounceCode,BounceType
2010-10-01 17:10:00,test1@yahoo.com,some test bounce code,UserUnknown 
2010-10-01 17:10:00,test2@yahoo.com,some test bounce code,MailboxFull 
2010-10-01 17:11:00,test3@yahoo.com,some test bounce code,Blocked 
2010-10-01 17:11:00,test4@yahoo.com,some test bounce code,OutOfOffice 
2010-10-01 17:12:00,test5@yahoo.com,some test bounce code,Unknown
2010-10-01 19:20:00,john.doe@gmail.com,some test bounce code,Other