全部產品
Search
文件中心

Direct Mail:發送資料相關介面

更新時間:Nov 30, 2024

擷取指定條件下的發送資料

郵件跟蹤擷取指定條件下的發送資料

郵件跟蹤擷取發送資料

擷取無效地址資訊

擷取發送詳情

擷取指定條件下的發送資料

描述

SenderStatisticsByTagNameAndBatchID 擷取指定條件下的發送資料

介面調用的頻率限制是50/分鐘

請求參數

名稱

類型

是否必須

描述

Action

String

系統規定參數,取值:SenderStatisticsByTagNameAndBatchID

AccountName

String

發信地址;不填,代表所有地址

TagName

String

郵件標籤;不填,代表所有標籤

StartTime

String

起始時間,時間不能早於30日,格式yyyy-MM-dd

EndTime

String

結束時間,和起始時間跨度不能超出7天, 格式yyyy-MM-dd

其他請求參數,請參見公用請求參數

返回參數

名稱

類型

描述

TotalCount

Integer

總數量

Data

Array

資料記錄

Data

名稱

類型

描述

createTime

String

建立時間

faildCount

String

失敗數量

requestCount

String

請求數量

succeededPercent

String

成功率

successCount

String

成功數量

unavailableCount

String

無效數量

unavailablePercent

String

無效率

公用返回參數,請參見公用返回參數

錯誤碼

錯誤碼

描述

Http狀態代碼

語義

InvalidDate.Malformed

時間格式非法

InvalidDate.NotFound

時間為空白

InvalidStartTime.Malformed

起始時間格式非法

InvalidBetweenTime.Malformed

時間跨度超出範圍

InvalidMailAddressName.Malformed

郵件位址名稱非法

InvalidMailAddress.NotFound

郵件位址名稱不存在

InvalidTagName.Malformed

郵件標籤非法

InvalidYear.Malformed

指定年份無效

InternalError

未知錯誤

郵件跟蹤擷取指定條件下的發送資料

描述

GetTrackListByMailFromAndTagName 郵件跟蹤擷取指定條件下的發送資料

請求參數

名稱

類型

是否必須

描述

Action

String

系統規定參數,取值:GetTrackListByMailFromAndTagName

AccountName

String

發信地址;不填,代表所有地址;若有TagName,此參數不為空白

TagName

String

郵件標籤;不填,代表所有標籤

StartTime

String

起始時間,時間不能早於30日,格式yyyy-MM-dd

EndTime

String

結束時間,和起始時間跨度不能超出15天,格式yyyy-MM-dd

Total

String

(本欄位已廢棄)

Offset

String

第一次查詢為0,後續固定為1。1為按照時間正序分頁查詢。(本欄位已廢棄)

PageSize

String

每頁大小

OffsetCreateTime

String

分頁用,第一次查詢不設定,後續查詢設定為上一次Response中sOffsetCreateTime值(本欄位已廢棄)

OffsetCreateTimeDesc

String

(本欄位已廢棄)

PageNumber

String

當前頁碼

其他請求參數,請參見公用請求參數

返回參數

名稱

類型

描述

OffsetCreateTime

String

分頁用

OffsetCreateTimeDesc

String

(本欄位已廢棄)

PageNo

Integer

頁碼

PageSize

Integer

分頁大小

TrackList

Array

跟蹤資料記錄

Total

Integer

(本欄位已廢棄)

TrackList

名稱

類型

描述

CreateTime

String

建立時間

RcptClickCount

String

點擊量

RcptOpenCount

String

開啟量

RcptUniqueClickCount

String

獨立點擊數

RcptUniqueClickRate

String

獨立點擊率

RcptUniqueOpenCount

String

獨立開啟數

RcptUniqueOpenRate

String

獨立開啟率

TotalNumber

String

總數

公用返回參數,請參見公用返回參數

錯誤碼

錯誤碼

描述

Http狀態代碼

語義

InvalidDate.Malformed

時間格式非法

InvalidDate.NotFound

時間為空白

InvalidStartTime.Malformed

起始時間格式非法

InvalidBetweenTime.Malformed

時間跨度超出範圍

InvalidMailAddressName.Malformed

郵件位址名稱非法

InvalidMailAddress.NotFound

郵件位址名稱不存在

InvalidTagName.Malformed

郵件標籤非法

InvalidYear.Malformed

指定年份無效

InternalError

未知錯誤

郵件跟蹤擷取發送資料

描述

GetTrackList 郵件跟蹤擷取發送資料

請求參數

名稱

類型

是否必須

描述

Action

String

系統規定參數,取值:GetTrackList

StartTime

String

起始時間,時間不能早於30日,格式yyyy-MM-dd

EndTime

String

結束時間,和起始時間跨度不能超出7天,格式yyyy-MM-dd

Total

String

(本欄位已廢棄)

Offset

String

第一次查詢為0,後續固定為1。1為按照時間正序分頁查詢。(本欄位已廢棄)

OffsetCreateTime

String

分頁用

OffsetCreateTimeDesc

String

(本欄位已廢棄)

PageNumber

String

頁碼

PageSize

String

分頁大小

其他請求參數,請參見公用請求參數

返回參數

名稱

類型

描述

OffsetCreateTime

String

分頁用

OffsetCreateTimeDesc

String

(本欄位已廢棄)

Total

Integer

(本欄位已廢棄)

PageNo

Integer

頁碼

PageSize

Integer

分頁大小

Data

Array

跟蹤資料記錄

Data

名稱

類型

描述

CreateTime

String

建立時間

RcptClickCount

String

點擊量

RcptOpenCount

String

開啟量

RcptUniqueClickCount

String

獨立點擊數

RcptUniqueClickRate

String

獨立點擊率

RcptUniqueOpenCount

String

獨立開啟數

RcptUniqueOpenRate

String

獨立開啟率

TotalNumber

String

總數

RcptClickRate

String

點擊率

RcptOpenRate

String

開啟率

公用返回參數,請參見公用返回參數

錯誤碼

錯誤碼

描述

Http狀態代碼

語義

InvalidDate.Malformed

時間格式非法

InvalidDate.NotFound

時間為空白

InvalidStartTime.Malformed

起始時間格式非法

InvalidBetweenTime.Malformed

時間跨度超出範圍

InvalidMailAddressName.Malformed

郵件位址名稱非法

InvalidMailAddress.NotFound

郵件位址名稱不存在

InvalidTagName.Malformed

郵件標籤非法

InvalidYear.Malformed

指定年份無效

InternalError

未知錯誤

擷取無效地址資訊

描述

QueryInvalidAddress 擷取去重的無效地址資訊,如果給同一個無效地址發送郵件多次,也會記錄第一次,需要根據第一次被判斷為無效地址分類的時間來查詢

請求參數

名稱

類型

是否必須

描述

Action

String

系統規定參數,取值:QueryInvalidAddress

StartTime

String

開始時間,時間不能早於30日,格式yyyy-MM-dd

EndTime

String

結束時間,和起始時間跨度不能超出30天,格式yyyy-MM-dd

KeyWord

String

關鍵詞;不填,代表所有無效地址

Length

Integer

每次請求數目

NextStart

String

請求開始位置

其他請求參數,請參見公用請求參數

返回參數

名稱

類型

描述

TotalCount

Integer

總數

Data

Array

資料

NextStart

String

下次請求開始位置

Data

名稱

類型

描述

mailDetail

List

記錄

mailDetail

名稱

類型

描述

ToAddress

String

收信地址

LastUpdateTime

String

更新時間

UtcLastUpdateTime

Long

更新時間(時間戳記格式)

公用返回參數,請參見公用返回參數

擷取發送詳情

描述

SenderStatisticsDetailByParam 擷取發送詳情

介面調用的頻率限制是500/分鐘

請求參數

名稱

類型

是否必須

描述

Action

String

系統規定參數,取值:SenderStatisticsDetailByParam

AccountName

String

發信地址;不填,代表所有地址;注意:AccountName、TagName、ToAddress可以都不填寫;若填寫,但只能傳遞其中一個參數,不能同時傳遞兩個或以上組合的參數

TagName

String

郵件標籤;不填,代表所有標籤

StartTime

String

起始時間,和結束時間跨度不能超出30天,格式yyyy-MM-dd HH:mm

EndTime

String

結束時間,和起始時間跨度不能超出30天, 格式yyyy-MM-dd HH:mm

ToAddress

String

收信地址;不填,代表所有收信地址

Status

Integer

投遞結果;不填,代表所有狀態:成功0,無效地址2,垃圾郵件3,失敗4

Length

Integer

指定本次請求返回結果數目。範圍是1~100

NextStart

String

分頁用,指定本次請求的位移量。如果還有更多結果,下次請求將該傳回值設定到請求中的NextStart

其他請求參數,請參見公用請求參數

返回參數

名稱

類型

描述

Data

Array

資料

NextStart

String

分頁使用。如果還有更多結果,下次請求將該傳回值設定到請求中的NextStart

Data

名稱

類型

描述

mailDetail

List

記錄

mailDetail

名稱

類型

描述

ToAddress

String

收信地址

LastUpdateTime

String

更新時間

UtcLastUpdateTime

String

更新時間(時間戳記格式)

AccountName

String

發信地址

Message

String

投遞詳情資訊

Status

Integer

投遞狀態:0 成功,2 無效地址,3 垃圾郵件,4 其餘失敗

Subject

String

郵件主題

ErrorClassification

String

錯誤原因的詳細分類:

  • SendOk

  • SmtpNxBox

公用返回參數,請參見公用返回參數