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):某個必須的字段缺失;