获取指定条件下的发送数据
描述
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 | 错误原因的详细分类:
等 |
公共返回参数,请参见公共返回参数。