Webservice方法-GetSMTPReportDetail接口
介绍
调用本接口可以查询满足输入查询条件的所有的详细记录,结果目前通过分页返回,每页显示数目和当前页数由您传入;
方法声明如下:
public SMTPReportDetailDTO GetSMTPReportDetail (EaseyeUserAccountDTOeaseyeUserAccountDTO, int reportType, int reportCategory, string email,string category, string campaign, stringuniqueMsgID, DateTime beginTime, DateTime endTime,int pageSize,int currentPageIndex)
输入
- EaseyeUserAccountDTO:easeyeUserAccountDTO
- 用户帐户信息(必填),其字段详细信息如下:
Index | Field | Type | Desc | 最佳实践 |
---|---|---|---|---|
1 | string(50) | 用户名(必填) | 登录名 | |
2 | Password | string(50) | 密码(必填) | 接口密码(不是人工登录密码) |
注:1)Email是用户名,也就是平台的登录帐号;
- int:reportType
- 报表类型(必填);
注:1)1代表SMTP事务邮件(27端口提交),2代表SMTP营销邮件(26端口提交),具体区别请参考开发前准备工作中的SMTP权限说明;
- int: reportCategory
- 报表类别(必填),其允许的值为0,1,2,3,4,5,6,7,七个数字中的一个,具体含义见以下备注:
0:返回当前状态;
1:发送明细;
2:成功明细;
3:打开明细;
4:点击明细;
5:硬退明细;
6:软退明细;
7:退订明细;
8:过滤明细;
- string:email
- 待模糊查询的邮件地址(可选,不填则默认查询满足其它条件的全部记录);
- 最佳实践:不填,或者设置为空""
- string:category
- 邮件类别(可选);
- 最佳实践:不填,或者设置为空""
- string:campaign
- 任务名称(可选);
- 最佳实践:不填,或者设置为空""
- string: UniqueMsgID
- 发送方唯一标识一封邮件的ID(可选,精确匹配) ;
- 最佳实践:不填,或者设置为空""
- 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
- 当前的页数(必填,正整数);
处理
根据条件查询分页SMTP报表明细,并将结果返回;
输出
- SMTPReportDetailDTO
- SMTP报表明细查询的返回信息,包含以下属性
Index | Field | Type | Desc |
---|---|---|---|
1 | ErrorCode | int | 错误码,3位整数, 2xx:处理成功; 3xx:部分成功; 4xx:临时错误; 5xx:永久错误 |
2 | ErrorInfo | string | 发生临时错误和永久 错误时,携带失败的原因 |
3 | SMTPReportDetailList | List <SMTPReportDetail> |
查询SMTP报表明细的返回信息 |
- List<SMTPReportDetail>
- 查询SMTP报表明细的返回信息,其SMTPReportDetail结构的字段详细信息如下:
Index | Field | Type | Desc |
---|---|---|---|
1 | String | 接收方邮件地址 | |
2 | SentDateTime | DateTime | 发送时间 |
3 | EventDateTime | DateTime | 事件发生时间 |
4 | Category | String | 邮件类别 |
5 | Campaign | String | 任务名称 |
6 | UniqueMsgID | String | 用户传入的标识 |
7 | IP | String | IP地址 |
8 | Region | String | 地域 |
9 | Link | String | 点击的链接地址 |
10 | Reason | String | 原因 |
11 | Status | int | smtp发送记录的当前状态。 1、发送中 3、投递成功 100、硬退 101、软退 112、过期 110、过滤未发 210、过滤未发 |
12 | UA | String | 客户端的原始UserAgentString (适用于Open打开和Click点击类型) |
13 | Platform | String | 客户端操作系统 (适用于Open打开和Click点击类型) |
14 | BrowserType | String | 客户端浏览器 (适用于Open打开和Click点击类型) |
- 常见调用失败情况
- (5xx):某个字段长度不符合定义;
- (5xx):某个必须的字段缺失;