Webservice方法-GetMailReportDetailExt接口

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

介绍

调用本接口可以查询指定群发列表在指定时间段内的某类数据的详细情况,由于返回数据量可能较大,结果目前通过分页返回,每页显示数目和当前页数由您传入;请尽量查询最近40小时内的数据,速度会比较快。
方法声明如下:

public MailReportDetailExtReturnDTOGetMailReportDetailExt (EaseyeUserAccountDTOeaseyeUserAccountDTO,
string mailListName, int sentFlag,DateTime datetimeFrom, DateTime datetimeTo,
int pageSize,int currentPageIndex)

输入

  • EaseyeUserAccountDTO:easeyeUserAccountDTO
用户帐户信息(必填),其字段详细信息如下:
Index Field Type Desc
1 Email string(50) 用户名(必填)
2 Password string(50) 密码(必填)
注:1)Email是用户名,也就是平台的登录帐号;
  • string:mailListName
待查询列表的名称(必填且精确匹配);
  • int:sentFlag
待查询的数据类型(必填):其允许值如下:
0:HardBounce硬退,
9:SoftBounce软退,
109:Drop过滤,
4:Open打开,
5:Click点击,
3:Unsubscribed退订,
1000:发送记录的当前状态,查询该类型时返回结果中的SubSentFlag将全部为0
  • DateTime:datetimeFrom
时间段下限(必填);
注:1)如果使用的编程语言中没有DateTime类型,可以传入字符串类型,格式为”yyyy-MM-ddThh:mm:ss”,其中,各个数值所占位数必须符合格式定义,
不足则补0,比如”2012-07-03T03:23:01”;
  • DateTime:datetimeTo
时间段上限(必填);
注:1)如果使用的编程语言中没有DateTime类型,可以传入字符串类型,格式为”yyyy-MM-ddThh:mm:ss”,其中,各个数值所占位数必须符合格式定义,
不足则补0,比如”2012-07-03T03:23:01”;
  • int:pageSize
每页显示的记录条数(必填,正整数,不大于1000);
  • int:currentPageIndex
当前的页数(必填,正整数);

处理

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

输出

  • MailReportDetailExtReturnDTO
报表总计查询的返回信息,包含以下属性
Index Field Type Desc
1 ErrorCode Int 错误码,3位整数,
2xx:处理成功;
3xx:部分成功;
4xx:临时错误;
5xx:永久错误
2 ErrorInfo string 发生临时错误和永久
错误时,携带失败的原因
3 TotalCount Int 记录总数
4 MailReportDetailExtDTOList List
< ReportDetailExt>
查询报表明细的返回信息
  • List<ReportDetailExt>
查询总报表的返回信息,其ReportDetailExt结构的字段详细信息如下:
Index Field Type Desc
1 Email String 接收方邮件地址
2 SentFlag Int 状态类型
3 SubSentFlag Int 状态子类型,详细说明见备注
4 EventDate DateTime 事件产生事件
5 AddDate DateTime 亿业平台处理的时间
(查询时间段会与该字段匹配)
6 UA String 客户端的原始UserAgentString
(适用于Open打开和Click点击类型)
7 Platform String 客户端操作系统
(适用于Open打开和Click点击类型)
8 BrowserType String 客户端浏览器
(适用于Open打开和Click点击类型)
9 Link String 点击的链接地址
(适用于Click点击类型)
10 Title String 链接的兴趣度分类
(适用于Click点击类型)
11 IP String 该操作的源IP
(适用于Open打开和Click点击类型)
注:1)SentFlag的值和传入参数的sentFlag值相同;
2)SentFlag和对应的SubSentFlag对照表
SentFlag SubSentFlag 类型说明
0:HardBounce硬退 0 硬退
9:SoftBounce软退 0 软退
100:已发送 0 已发送
109:Drop过滤 110
111
112
210
硬退过滤
超过限量过滤
过期未发
退订过滤
4:Open打开 0 打开
5:Click点击 0 点击
3:Unsubscribed退订 0
202
用户自行退订
用户投诉退订
常见调用失败情况
(4xx):业务限制;
(4xx):数据库操作失败;
(5xx):某个字段长度不符合定义;
(5xx):某个必须的字段缺失;