Webservice方法-GetMailSumReport接口

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

介绍

调用本接口可以查询若干个列表的发送情况;
方法声明如下:

public MailSumReportReturnDTO GetMailSumReport(EaseyeUserAccountDTO easeyeUserAccountDTO,
string projectName, string maillistName,DateTime sentDatetimeFrom, DateTime sentDatetimeTo)

输入

  • EaseyeUserAccountDTO:easeyeUserAccountDTO
用户帐户信息(必填),其字段详细信息如下:
Index Field Type Desc 最佳实践
1 Email string(50) 用户名(必填) 登录名
2 Password string(50) 密码(必填) 接口密码(不是人工登录密码
注:1)Email是用户名,也就是平台的登录帐号;
  • string:projectName
待查询列表所在项目(可选);
最佳实践:不填,或者设置为空""
  • string:maillistName
待查询的列表名称(可选);
最佳实践:不填,或者设置为空""
  • DateTime:sentDatetimeFrom
查询的开始时间(可选);
最佳实践:填写为10天前的凌晨0点0分0秒
注:1)如果使用的编程语言中没有DateTime类型,可以传入字符串类型,格式为”yyyy-MM-ddThh:mm:ss”,其中,各个数值所占位数必须符合格式定义,
不足则补0,比如”2012-07-03T03:23:01”;
  • DateTime:sentDatetimeTo
查询的结束时间(可选);
最佳实践:填写为今天的23点59分59秒
注:1)如果使用的编程语言中没有DateTime类型,可以传入字符串类型,格式为”yyyy-MM-ddThh:mm:ss”,其中,各个数值所占位数必须符合格式定义,
不足则补0,比如”2012-07-03T03:23:01”;

处理

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

输出

  • MailSumReportReturnDTO
报表总计查询的返回信息,包含以下属性
Index Field Type Desc
1 ErrorCode Int 错误码,3位整数,
2xx:处理成功;
3xx:部分成功;
4xx:临时错误;
5xx:永久错误
2 ErrorInfo string 发生临时错误和永久
错误时,携带失败的原因
3 MailSumReportDTOList List
<MailStatusReportDTO>
查询总报表的返回信息
  • List<MailStatusReportDTO>
查询总报表的返回信息,其MailStatusReportDTO结构的字段详细信息如下:
Index Field Type Desc
1 Sent int 发送数量
2 Bounce int 硬退信数量
3 BounceFalse int 软退信数量
4 OptOut int 退订数量
5 Open int 打开数量
6 Success int 成功数量
7 MailClicked int 邮件点击数
8 Transmit int 转发数
9 SendTime DateTime 发送时间
10 FinishTime DateTime 结束时间
11 SentMailListId int 本次发送的ID,用来查询详细报表报表
12 MailListName string 本次发送的邮件列表名称
13 MailProjectName string 本列表所属项目名称
注:1)硬退是指地址不存在;
2)软退是指非地址不存在造成的失败;
3)邮件点击数是指邮件点击人数,单人点击多次仍然只计入一次;
常见调用失败情况
(4xx):业务限制;
(4xx):数据库操作失败;
(5xx):某个字段长度不符合定义;
(5xx):某个必须的字段缺失;