Webservice方法-GetSMTPBulkReport接口

来自亿业科技接口
跳转至: 导航搜索

介绍

调用本接口可以查询SMTP群发汇总的报表,结果目前通过分页返回,每页显示数目和当前页数由您传入;
方法声明如下:

public SMTPBulkReportDTO GetSMTPBulkReport (EaseyeUserAccountDTO easeyeUserAccountDTO,
string category, string campaign, DateTime beginTime, DateTime endTime,
int pageSize,int currentPageIndex)

输入

  • EaseyeUserAccountDTO:easeyeUserAccountDTO
用户帐户信息(必填),其字段详细信息如下:
Index Field Type Desc 最佳实践
1 Email string(50) 用户名(必填) 登录名
2 Password string(50) 密码(必填) 接口密码(不是人工登录密码
注:1)Email是用户名,也就是平台的登录帐号;
  • string:category
邮件类别(可选);
最佳实践:不填或者设置为空""
  • string:campaign
任务名称(可选);
最佳实践:不填或者设置为空""
  • DateTime:beginTime
查询报表的开始时间;
最佳实践:填写为10天前的凌晨0点0分0秒
注:1)如果使用的编程语言中没有DateTime类型,可以传入字符串类型,格式为”yyyy-MM-ddThh:mm:ss”,其中,各个数值所占位数必须符合格式定义,
不足则补0,比如”2012-07-03T03:23:01”;
  • DateTime:endTime
查询报表的结束时间(必须大于等于开始时间);
最佳实践:填写为今天的23点59分59秒
注:1)如果使用的编程语言中没有DateTime类型,可以传入字符串类型,格式为”yyyy-MM-ddThh:mm:ss”,其中,各个数值所占位数必须符合格式定义,
不足则补0,比如”2012-07-03T03:23:01”;
  • int:pageSize
每页显示的记录条数(必填,正整数,但不大于1000);
  • int:currentPageIndex
当前的页数(必填,正整数);

处理

根据条件查询报表,并将结果返回;

输出

  • SMTPBulkReportDTO
报表总计查询的返回信息,包含以下属性
Index Field Type Desc
1 ErrorCode int 错误码,3位整数,
2xx:处理成功;
3xx:部分成功;
4xx:临时错误;
5xx:永久错误
2 ErrorInfo string 发生临时错误和永久
错误时,携带失败的原因
3 SMTPBulkReportList List
<SMTPBulkReport>
查询SMTP群发汇总报表的返回信息
  • List<SMTPBulkReport>
查询SMTP群发汇总报表的返回信息,其SMTPBulkReport结构的字段详细信息如下:
Index Field Type Desc
1 Category String 邮件类型
2 campaign String 任务名称
3 CountDateTime DateTime 报表统计时间
4 ProcessCount int 发送数
5 SuccessCount int 成功数
6 OpenCount int 打开数
7 ClickCount int 点击数
8 ClickTimes int 点击总数
9 HardBounce int 硬退数
10 SoftBounce int 软退数
11 UnsubscribeCount int 退订数
注:1)硬退是指地址不存在;
2)软退是指非地址不存在造成的失败;
3)ClickCount是指邮件点击人数,单人点击多次仍然只计入一次ClickTimes指的是点击总数
常见调用失败情况
(5xx):某个字段不符合定义或者规范;