Webservice方法-GetSMTPBulkReport介面

出自亿业科技接口
在2017年2月16日 (四) 10:03由Lebesgue.yu對話 | 貢獻所做的修訂版本

(差異) ←上個修訂 | 最新修訂 (差異) | 下一修訂→ (差異)
跳轉到: 導覽搜尋

介紹

調用本介面可以查詢SMTP群發匯總的報表,結果目前通過分頁返回,每頁顯示數目和當前頁數由您傳入;
方法聲明如下:

public SMTPBulkReportDTO GetSMTPBulkReport (EaseyeUserAccountDTO easeyeUserAccountDTO,
string category, string campaign, DateTime beginTime, DateTime endTime,
int pageSize,int currentPageIndex)

輸入

  • EaseyeUserAccountDTO:easeyeUserAccountDTO
用戶帳戶信息(必填),其欄位詳細信息如下:
Index Field Type Desc 最佳實踐
1 Email string(50) 用戶名(必填) 登錄名
2 Password string(50) 密碼(必填) 介面密碼(不是人工登錄密碼
注:1)Email是用户名,也就是平台的登录帐号;
  • string:category
郵件類別(可選);
最佳實踐:不填或者設置為空""
  • string:campaign
任務名稱(可選);
最佳實踐:不填或者設置為空""
  • 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
當前的頁數(必填,正整數);

處理

根據條件查詢報表,並將結果返回;

輸出

  • SMTPBulkReportDTO
報表總計查詢的返回信息,包含以下屬性
Index Field Type Desc
1 ErrorCode int 錯誤碼,3位整數,
2xx:處理成功;
3xx:部分成功;
4xx:臨時錯誤;
5xx:永久錯誤
2 ErrorInfo string 發生臨時錯誤和永久
錯誤時,攜帶失敗的原因
3 SMTPBulkReportList List
<SMTPBulkReport>
查詢SMTP群發匯總報表的返回信息
  • List<SMTPBulkReport>
查詢SMTP群發匯總報表的返回信息,其SMTPBulkReport結構的欄位詳細信息如下:
Index Field Type Desc
1 Category String 郵件類型
2 campaign String 任務名稱
3 CountDateTime DateTime 報表統計時間
4 ProcessCount int 發送數
5 SuccessCount int 成功數
6 OpenCount int 打開數
7 ClickCount int 點擊數
8 ClickTimes int 點擊總數
9 HardBounce int 硬退數
10 SoftBounce int 軟退數
11 UnsubscribeCount int 退訂數
注:1)硬退是指地址不存在;
2)软退是指非地址不存在造成的失败;
3)ClickCount是指邮件点击人数,单人点击多次仍然只计入一次ClickTimes指的是点击总数
常見調用失敗情況
(5xx):某個欄位不符合定義或者規範;