Webservice方法-GetMailReportDetail接口
介绍
调用本接口可以查询某次发送的某类数据的详细情况,由于返回数据量可能较大,结果目前通过分页返回,每页显示数目和当前页数由您传入;
方法声明如下:
public MailReportDetailReturnDTO GetMailReportDetail(EaseyeUserAccountDTO easeyeUserAccountDTO, int sentMailListId, int sentFlag,int pageSize,int currentPageIndex)
输入
- EaseyeUserAccountDTO:easeyeUserAccountDTO
- 用户帐户信息(必填),其字段详细信息如下:
Index | Field | Type | Desc | 最佳实践 |
---|---|---|---|---|
1 | string(50) | 用户名(必填) | 登录名 | |
2 | Password | string(50) | 密码(必填) | 接口密码(不是人工登录密码) |
注:1)Email是用户名,也就是平台的登录帐号;
- int:sentMailListId
- 待查询列表的唯一编号(必填);
注:1)该编号是从获取列表明细接口中获取到的:
- int:sentFlag
- 待查询的类型(必填):其允许值如下:
- 0:硬退类型,3:退订类型,4:打开类型,5:点击类型;9:软退类型,
- int:pageSize
- 每页显示的记录条数(必填,正整数,不大于1000);
- int:currentPageIndex
- 当前的页数(必填,正整数);
处理
根据条件查询分页报表,并将结果返回;
输出
- MailReportDetailReturnDTO
- 报表总计查询的返回信息,包含以下属性
Index | Field | Type | Desc |
---|---|---|---|
1 | ErrorCode | Int | 错误码,3位整数, 2xx:处理成功; 3xx:部分成功; 4xx:临时错误; 5xx:永久错误 |
2 | ErrorInfo | string | 发生临时错误和永久 错误时,携带失败的原因 |
3 | MailReportDetailDTOList | List < ReportDetail> |
查询报表明细的返回信息 |
- List<ReportDetail>
- 查询总报表的返回信息,其ReportDetail结构的字段详细信息如下:
Index | Field | Type | Desc |
---|---|---|---|
1 | String | 接收方邮件地址 | |
2 | SentFlag | int | 状态类型 |
3 | ModifiedDate | DateTime | 操作时间(在点击报表中,指 最后一次的链接点击时间 ) |
4 | Link | String | 点击的链接地址(适用于点击 类型或者转发的邮件地址) |
5 | Times | int | 点击次数(只适用于点击类型) |
6 | IPAddress | String | 该操作的源IP |
注:1)SentFlag的值和传入参数的sentFlag值相同;
2)ModifiedDate在点击类型查询中,是指该用户最后一次点击该链接的时间;在其他类型的查询中,是指该操作的发生时间;
- 常见调用失败情况
- (4xx):业务限制;
- (4xx):数据库操作失败;
- (5xx):某个字段长度不符合定义;
- (5xx):某个必须的字段缺失;