tencent cloud

APIs

文档APIsSimple Email ServiceData Types

数据结构

下载
聚焦模式
字号
最后更新时间： 2026-07-14 18:00:32

AbuseReport

垃圾投诉数据

被如下接口引用：GetAbuseReport。

名称 类型 必选 描述
DeliverTime String 否

发送时间
OriginalMailFrom String 否

发信地址
OriginalRcptTo String 否

收信地址
FromDomain String 否

发信域名
ComplainTime String 否

投诉时间
Mta String 否

收信域名
SourceIp String 否

来源ip
InsertTime String 否

数据时间
TemplateId String 否

模板ID
BulkId String 否

bulkId
MessageId String 否

邮件Message-Id
AbuseTime String 否

投诉时间
Subject String 否

邮件主题

AddressUnsubscribeConfigData

地址级退订配置

被如下接口引用：ListAddressUnsubscribeConfig。

名称 类型 必选 描述
Address String 否 发信地址
UnsubscribeConfig String 否 退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语
Status Integer 否 0:关闭，1:开启

Attachment

附件结构，包含附件名和base64之后的附件内容。

被如下接口引用：BatchSendEmail, SendEmail。

名称 类型 必选 描述
FileName String 是 附件名称，最大支持255个字符长度，不支持部分附件类型，详情请参考附件类型。
Content String 否 Base64之后的附件内容，您可以发送的附件大小上限为4M。注意：腾讯云接口请求最大支持 8M 的请求包，附件内容经过 Base64 预期扩大1.5倍。应该控制所有附件的总大小最大在 4M 以内，整体请求超出 8M 接口会返回错误。
FileURL String 否 附件URL。未开放功能，请勿使用。

BlackAddressDetail

黑名单详情

被如下接口引用：ListCustomBlacklist。

名称 类型 描述
Id Integer 黑名单地址id
Email String 邮箱地址
CreateTime String 创建时间
ExpireDate String 过期时间
Status Integer 黑名单状态，0:已过期，1:生效中

BlackEmailAddress

邮箱黑名单结构，包含被拉黑的邮箱地址和被拉黑时间，以及被拉黑的理由

被如下接口引用：ListBlackEmailAddress。

名称 类型 描述
BounceTime Timestamp 邮箱被拉黑时间
EmailAddress String 被拉黑的邮箱地址
IspDesc String 被拉黑的理由

CycleEmailParam

创建重复周期发送邮件任务的参数

被如下接口引用：BatchSendEmail, ListSendTasks。

名称 类型 必选 描述
BeginTime String 是 任务开始时间
IntervalTime Integer 是 任务周期 小时维度
TermCycle Integer 否 是否终止周期，用于任务更新 0否1是

DNSAttributes

用于描述DNS记录的域名、记录类型、期望得到的值、目前配置的值

被如下接口引用：CreateEmailIdentity, GetEmailIdentity, UpdateEmailIdentity。

名称 类型 描述
Type String 记录类型 CNAME
SendDomain String 域名
ExpectedValue String 需要配置的值
CurrentValue String 腾讯云目前检测到的值
Status Boolean 检测是否通过，创建时默认为false

EmailIdentity

发信域名验证列表结构体

被如下接口引用：ListEmailIdentities。

名称 类型 描述
IdentityName String

发信域名
IdentityType String

验证类型，固定为DOMAIN
SendingEnabled Boolean

是否已通过验证
CurrentReputationLevel Integer

当前信誉等级
DailyQuota Integer

当日最高发信量
SendIp Array of String

域名配置的独立ip
TagList Array of TagList

tag 标签
DKIMOption Integer

dkim位数

枚举值：

  • 0： 1024
  • 1： 2048
  • 2： 双签

默认值：0

EmailSender

用于描述发件人相关信息

被如下接口引用：ListEmailAddress。

名称 类型 描述
EmailAddress String 发信地址
EmailSenderName String 发信人别名
CreatedTimestamp Integer 创建时间
SmtpPwdType Integer smtp密码类型,0=没有设置密码,1=已经设置了密码

ReceiverData

收件人列表数据类型

被如下接口引用：ListReceivers。

名称 类型 描述
ReceiverId Integer 收件人列表ID
ReceiversName String 收件人列表名称
Count Integer 收件人地址总数
Desc String 收件人列表描述
ReceiversStatus Integer 列表状态(1 待上传 2 上传中 3 上传完成)
CreateTime String 创建时间,如:2021-09-28 16:40:35
InvalidCount Integer 无效收件人数量

ReceiverDetail

收件人列表详情

被如下接口引用：ListReceiverDetails。

名称 类型 描述
Email String 收件人地址
CreateTime String 创建时间
TemplateData String 模板参数
Reason String 无效原因
Status Integer 1:有效，2:无效
EmailId Integer 收件人地址id

ReceiverInputData

收件人明细输入参数，包含收件人邮箱，以及模板参数

被如下接口引用：CreateReceiverDetailWithData。

名称 类型 必选 描述
Email String 是 收件人邮箱
TemplateData String 是 模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。
注意：参数值不能是html等复杂类型的数据。TemplateData (整个 JSON 结构) 总长度限制为 800 bytes。

SendEmailStatus

描述邮件发送状态

被如下接口引用：GetSendEmailStatus。

名称 类型 描述
MessageId String SendEmail返回的MessageId
ToEmailAddress String 收件人邮箱
FromEmailAddress String 发件人邮箱
SendStatus Integer 腾讯云处理状态
0: 处理成功
1001: 内部系统异常
1002: 内部系统异常
1003: 内部系统异常
1003: 内部系统异常
1004: 发信超时
1005: 内部系统异常
1006: 触发频率控制，短时间内对同一地址发送过多邮件
1007: 邮件地址在黑名单中
1008: 域名被收件人拒收
1009: 内部系统异常
1010: 超出了每日发送限制
1011: 无发送自定义内容权限，必须使用模板
1013: 域名被收件人取消订阅
2001: 找不到相关记录
3007: 模板ID无效或者不可用
3008: 被收信域名临时封禁
3009: 无权限使用该模板
3010: TemplateData字段格式不正确
3014: 发件域名没有经过认证，无法发送
3020: 收件方邮箱类型在黑名单
3024: 邮箱地址格式预检查失败
3030: 退信率过高，临时限制发送
3033: 余额不足，账号欠费等
DeliverStatus Integer 收件方处理状态
0: 请求成功被腾讯云接受，进入发送队列
1: 邮件递送成功，DeliverTime表示递送成功的时间
2: 邮件因某种原因被丢弃，DeliverMessage表示丢弃原因
3: 收件方ESP拒信，一般原因为邮箱地址不存在，或其它原因
8: 邮件被ESP因某些原因延迟递送，DeliverMessage表示延迟原因
DeliverMessage String 收件方处理状态描述
RequestTime Integer 请求到达腾讯云时间戳
DeliverTime Integer 腾讯云执行递送时间戳
UserOpened Boolean 用户是否打开该邮件
UserClicked Boolean 用户是否点击该邮件中的链接
UserUnsubscribed Boolean 用户是否取消该发送者的订阅
UserComplained Boolean 用户是否举报该发送者

SendTaskData

发送任务数据

被如下接口引用：ListSendTasks。

名称 类型 描述
TaskId Integer 任务id
FromEmailAddress String 发信地址
ReceiverId Integer 收件人列表Id
TaskStatus Integer 任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成
TaskType Integer 任务类型 1 即时 2 定时 3 周期
RequestCount Integer 任务请求发信数量
SendCount Integer 已经发送数量
CacheCount Integer 缓存数量
CreateTime String 任务创建时间
UpdateTime String 任务更新时间
Subject String 邮件主题
Template Template 模板和模板数据
CycleParam CycleEmailParam 周期任务参数
注意：此字段可能返回 null，表示取不到有效值。
TimedParam TimedEmailParam 定时任务参数
注意：此字段可能返回 null，表示取不到有效值。
ErrMsg String 任务异常信息
ReceiversName String 收件人列表名称

Simple

邮件发送的内容，可以是纯文本(TEXT)，也可以是纯代码(HTML)，或者纯文本+HTML的组合(建议方式)

被如下接口引用：BatchSendEmail, SendEmail。

名称 类型 必选 描述
Html String 否 base64之后的Html代码。需要包含所有的代码信息，不要包含外部css，否则会导致显示格式错乱
Text String 否 base64之后的纯文本信息，如果没有Html，邮件中会直接显示纯文本；如果有Html，它代表邮件的纯文本样式

TagList

标签

被如下接口引用：CreateEmailIdentity, GetEmailIdentity, ListEmailIdentities。

名称 类型 必选 描述
TagKey String 是 产品
TagValue String 是 ses

Template

模板发送相关信息，包含模板ID，模板变量参数等信息

被如下接口引用：BatchSendEmail, ListSendTasks, SendEmail。

名称 类型 必选 描述
TemplateID Integer 是 模板ID。如果没有模板，请先新建一个
TemplateData String 是 模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。
注意：参数值不能是html等复杂类型的数据。
示例：{"name":"xxx","age":"xx"}

TemplateContent

模板内容，TEXT和HTML必须至少存在一项，建议使用TEXT和HTML的组合

被如下接口引用：CreateEmailTemplate, GetEmailTemplate, UpdateEmailTemplate。

名称 类型 必选 描述
Html String 否 base64之后的Html代码
Text String 否 base64之后的文本内容

TemplatesMetadata

模板列表结构

被如下接口引用：ListEmailTemplates。

名称 类型 描述
CreatedTimestamp Integer 创建时间
TemplateName String 模板名称
TemplateStatus Integer 模板状态。1-审核中
TemplateID Integer 模板ID
ReviewReason String 审核原因

TimedEmailParam

创建定时发送邮件任务时，设置的定时参数，比如开始时间之类

被如下接口引用：BatchSendEmail, ListSendTasks。

名称 类型 必选 描述
BeginTime String 是 定时发送邮件的开始时间

Volume

统计数据的结构体

被如下接口引用：GetStatisticsReport。

名称 类型 描述
SendDate Date

日期
RequestCount Integer

邮件请求数量
AcceptedCount Integer

腾讯云通过数量
DeliveredCount Integer

送达数量
OpenedCount Integer

打开邮件总次数
ClickedCount Integer

点击了邮件中的链接数量用户数量
BounceCount Integer

退信数量
UnsubscribeCount Integer

取消订阅的用户数量
上一篇: CreateCustomBlacklist下一篇: Error Codes

帮助和支持

本页内容是否解决了您的问题？

填写满意度调查问卷，共创更好文档体验。

文档反馈

搜索
    请输入关键词搜索文档