{
  "name": "ses",
  "display_name": "邮件推送",
  "description": "介绍如何使用API进行邮件发送操作，包括发信域名管理、DNS验证、模板管理、数据统计等。",
  "domain": "other",
  "api_version": "2020-10-02",
  "endpoint": "ses.tencentcloudapi.com",
  "actions": [
    {
      "name": "BatchSendEmail",
      "description": "您可以通过此API批量发送TEXT或者HTML邮件，适用于营销类、通知类邮件。默认仅支持使用模板发送邮件。批量发送之前，需先创建收件人列表，和收件人地址，并通过收件人列表id来进行发送。批量发送任务支持定时发送和周期重复发送，定时发送需传TimedParam，周期重复发送需传CycleParam",
      "status": "online",
      "parameters": [
        {
          "name": "FromEmailAddress",
          "type": "string",
          "required": true,
          "description": "发信邮件地址。请填写发件人邮箱地址，例如：noreply@mail.qcloud.com。如需填写发件人说明，请按照 发信人 \u0026lt;邮件地址\u0026gt; 的方式填写，例如： 腾讯云团队 \u0026lt;noreply@mail.qcloud.com\u0026gt;",
          "example": "test@example.com"
        },
        {
          "name": "ReceiverId",
          "type": "integer",
          "required": true,
          "description": "收件人列表ID",
          "example": "1"
        },
        {
          "name": "Subject",
          "type": "string",
          "required": true,
          "description": "邮件主题",
          "example": "邮件主题"
        },
        {
          "name": "TaskType",
          "type": "integer",
          "required": true,
          "description": "任务类型 1: 立即发送 2: 定时发送 3: 周期（频率）发送",
          "example": "1"
        },
        {
          "name": "ReplyToAddresses",
          "type": "string",
          "required": false,
          "description": "邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址，可以是个人邮箱。如果不填，收件人的回复邮件将会发送失败。",
          "example": "test@example.com"
        },
        {
          "name": "Template",
          "type": "object",
          "required": false,
          "description": "使用模板发送时，填写的模板相关参数 如您未申请过特殊配置，则该字段为必填",
          "example": "无",
          "children": [
            {
              "name": "TemplateID",
              "type": "integer",
              "required": true,
              "description": "模板ID。如果没有模板，请先新建一个",
              "example": "1"
            },
            {
              "name": "TemplateData",
              "type": "string",
              "required": true,
              "description": "模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。 注意：参数值不能是html等复杂类型的数据。 示例：{\"name\":\"xxx\",\"age\":\"xx\"}",
              "example": "{\"name\":\"andy\",\"age\":\"24\"}"
            }
          ]
        },
        {
          "name": "Simple",
          "type": "object",
          "required": false,
          "description": "已废弃 仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置，则不存在该字段。",
          "example": "无",
          "children": [
            {
              "name": "Html",
              "type": "string",
              "required": false,
              "description": "base64之后的Html代码。需要包含所有的代码信息，不要包含外部css，否则会导致显示格式错乱",
              "example": "PGh0bWw+PGhlYWQ+PHRpdGxlPkV4YW1wbGUgSFRNTDwvdGl0bGU+PC9oZWFkPjxib2R5PjxwPkhlbGxvLCB3b3JsZDwvcD48L2JvZHk+PC9odG1sPg=="
            },
            {
              "name": "Text",
              "type": "string",
              "required": false,
              "description": "base64之后的纯文本信息，如果没有Html，邮件中会直接显示纯文本；如果有Html，它代表邮件的纯文本样式",
              "example": "SGVsbG8sIHdvcmxkIQ=="
            }
          ]
        },
        {
          "name": "Attachments",
          "type": "array",
          "required": false,
          "description": "需要发送附件时，填写附件相关参数（暂未支持）",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FileName",
              "type": "string",
              "required": true,
              "description": "附件名称，最大支持255个字符长度，不支持部分附件类型，详情请参考[附件类型](https://cloud.tencent.com/document/product/1288/51951)。",
              "example": "example.txt"
            },
            {
              "name": "Content",
              "type": "string",
              "required": false,
              "description": "Base64之后的附件内容，您可以发送的附件大小上限为4M。注意：腾讯云接口请求最大支持 8M 的请求包，附件内容经过 Base64 预期扩大1.5倍。应该控制所有附件的总大小最大在 4M 以内，整体请求超出 8M 接口会返回错误。",
              "example": "dGhpcyBpcyBhIGV4YW1wbGU="
            },
            {
              "name": "FileURL",
              "type": "string",
              "required": false,
              "description": "附件URL。未开放功能，请勿使用。",
              "example": "https://www.test.com/1.png"
            }
          ]
        },
        {
          "name": "CycleParam",
          "type": "object",
          "required": false,
          "description": "周期发送任务的必要参数",
          "example": "无",
          "children": [
            {
              "name": "BeginTime",
              "type": "string",
              "required": true,
              "description": "任务开始时间",
              "example": "2021-09-11 09:10:11"
            },
            {
              "name": "IntervalTime",
              "type": "integer",
              "required": true,
              "description": "任务周期 小时维度",
              "example": "1"
            },
            {
              "name": "TermCycle",
              "type": "integer",
              "required": false,
              "description": "是否终止周期，用于任务更新 0否1是",
              "example": "0"
            }
          ]
        },
        {
          "name": "TimedParam",
          "type": "object",
          "required": false,
          "description": "定时发送任务的必要参数",
          "example": "无",
          "children": [
            {
              "name": "BeginTime",
              "type": "string",
              "required": true,
              "description": "定时发送邮件的开始时间",
              "example": "2021-09-11 09:10:11"
            }
          ]
        },
        {
          "name": "Unsubscribe",
          "type": "string",
          "required": false,
          "description": "退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语",
          "example": "1"
        },
        {
          "name": "ADLocation",
          "type": "integer",
          "required": false,
          "description": "是否添加广告标识 0:不添加 1:添加到subject前面，2:添加到subject后面",
          "example": "0"
        }
      ],
      "required": [
        "FromEmailAddress",
        "ReceiverId",
        "Subject",
        "TaskType"
      ]
    },
    {
      "name": "CreateAddressUnsubscribeConfig",
      "description": "创建地址级退订配置",
      "status": "online",
      "parameters": [
        {
          "name": "Address",
          "type": "string",
          "required": true,
          "description": "发信地址",
          "example": "test@exmaple.com"
        },
        {
          "name": "UnsubscribeConfig",
          "type": "string",
          "required": true,
          "description": "退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语",
          "example": "0"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "0:关闭，1:打开",
          "example": "1"
        }
      ],
      "required": [
        "Address",
        "UnsubscribeConfig",
        "Status"
      ]
    },
    {
      "name": "CreateCustomBlacklist",
      "description": "添加自定义黑名单",
      "status": "online",
      "parameters": [
        {
          "name": "Emails",
          "type": "array",
          "required": true,
          "description": "添加到黑名单的邮件地址",
          "example": "[ \"a@gmail.com\" , \"b@gmail.com\"]",
          "item_type": "string"
        },
        {
          "name": "ExpireDate",
          "type": "string",
          "required": false,
          "description": "过期日期",
          "example": "\"2024-06-19\""
        }
      ],
      "required": [
        "Emails"
      ]
    },
    {
      "name": "CreateEmailAddress",
      "description": "在验证了发信域名之后，您需要一个发信地址来发送邮件。例如发信域名是mail.qcloud.com，那么发信地址可以为 service@mail.qcloud.com。如果您想要收件人在收件箱列表中显示您的别名，例如\"腾讯云邮件通知\"。那么发信地址为： 别名 空格 尖括号 邮箱地址。请注意中间需要有空格",
      "status": "online",
      "parameters": [
        {
          "name": "EmailAddress",
          "type": "string",
          "required": true,
          "description": "您的发信地址（发信地址总数上限为10个）",
          "example": "service@mail.qcloud.com"
        },
        {
          "name": "EmailSenderName",
          "type": "string",
          "required": false,
          "description": "发件人别名",
          "example": "腾讯云邮件通知"
        }
      ],
      "required": [
        "EmailAddress"
      ]
    },
    {
      "name": "CreateEmailIdentity",
      "description": "在使用身份发送电子邮件之前，您需要有一个电子邮件域名，该域名可以是您的网站或者移动应用的域名。您首先必须进行验证，证明自己是该域名的所有者，并且授权给腾讯云SES发送许可，才可以从该域名发送电子邮件。",
      "status": "online",
      "parameters": [
        {
          "name": "EmailIdentity",
          "type": "string",
          "required": true,
          "description": "您的发信域名，建议使用三级以上域名。例如：mail.qcloud.com。",
          "example": "mail.qcloud.com"
        },
        {
          "name": "DKIMOption",
          "type": "integer",
          "required": false,
          "description": "生成的dkim密钥长度。0:1024，1:2048",
          "example": "0"
        },
        {
          "name": "TagList",
          "type": "array",
          "required": false,
          "description": "tag 标签",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "产品",
              "example": "tagkey"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "ses",
              "example": "tagvalue"
            }
          ]
        }
      ],
      "required": [
        "EmailIdentity"
      ]
    },
    {
      "name": "CreateEmailTemplate",
      "description": "创建模板，该模板可以是TXT或者HTML，请注意如果HTML不要包含外部文件的CSS。模板中的变量使用 {{变量名}} 表示。 注意：模板需要审核通过才可以使用。",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateName",
          "type": "string",
          "required": true,
          "description": "模板名称",
          "example": "TestName"
        },
        {
          "name": "TemplateContent",
          "type": "object",
          "required": true,
          "description": "模板内容",
          "example": "无",
          "children": [
            {
              "name": "Html",
              "type": "string",
              "required": false,
              "description": "base64之后的Html代码",
              "example": "PGh0bWw+PGhlYWQ+PHRpdGxlPkV4YW1wbGUgSFRNTDwvdGl0bGU+PC9oZWFkPjxib2R5PjxwPkhlbGxvLCB3b3JsZDwvcD48L2JvZHk+PC9odG1sPg=="
            },
            {
              "name": "Text",
              "type": "string",
              "required": false,
              "description": "base64之后的文本内容",
              "example": "SGVsbG8sIHdvcmxkIQ=="
            }
          ]
        }
      ],
      "required": [
        "TemplateName",
        "TemplateContent"
      ]
    },
    {
      "name": "CreateReceiver",
      "description": "创建收件人列表，收件人列表是发送批量邮件的目标邮件地址列表。创建列表后，需要上传收件人邮箱地址。之后创建发送任务，关联列表，便可以实现批量发送邮件的功能",
      "status": "online",
      "parameters": [
        {
          "name": "ReceiversName",
          "type": "string",
          "required": true,
          "description": "收件人列表名称",
          "example": "收件人列表"
        },
        {
          "name": "Desc",
          "type": "string",
          "required": false,
          "description": "收件人列表描述",
          "example": "收件人列表描述"
        }
      ],
      "required": [
        "ReceiversName"
      ]
    },
    {
      "name": "CreateReceiverDetail",
      "description": "在创建完收件人列表后，向这个收件人列表中批量增加收件人邮箱地址，一次最大支持2万，异步完成处理。数据量比较大的时候，上传可能需要一点时间，可以通过查询收件人列表了解上传状态和上传数量。本接口与接口CreateReceiverDetailWithData的功能特性基本一致，只是不支持上传发信时的模板参数。用户首先调用创建收件人列表接口-CreateReceiver后，然后调用本接口传入收件人...",
      "status": "online",
      "parameters": [
        {
          "name": "ReceiverId",
          "type": "integer",
          "required": true,
          "description": "收件人列表ID",
          "example": "1"
        },
        {
          "name": "Emails",
          "type": "array",
          "required": true,
          "description": "邮箱",
          "example": "[\"example@gmail.com\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "ReceiverId",
        "Emails"
      ]
    },
    {
      "name": "CreateReceiverDetailWithData",
      "description": "添加收件人地址附带模板参数，使用本接口在添加收件人地址的同时传入模板参数，使每一个收件人地址在发信的时候使用的模板变量取值不同。用户首先调用创建收件人列表接口-CreateReceiver后，然后调用本接口传入收件人地址和发信时的模板参数，最后使用批量发送邮件接口-BatchSendEmail，即可完成批量发信。需要注意的是在使用本接口后BatchSendEmail接口中的Template参数不需再\ufffd...",
      "status": "online",
      "parameters": [
        {
          "name": "ReceiverId",
          "type": "integer",
          "required": true,
          "description": "收件人列表ID",
          "example": "1"
        },
        {
          "name": "Datas",
          "type": "array",
          "required": true,
          "description": "收信人邮箱以及模板参数，数组形式。收件人个数限制20000个以内。",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "Email",
              "type": "string",
              "required": true,
              "description": "收件人邮箱",
              "example": "abc@ef.com"
            },
            {
              "name": "TemplateData",
              "type": "string",
              "required": true,
              "description": "模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。 注意：参数值不能是html等复杂类型的数据。TemplateData (整个 JSON 结构) 总长度限制为 800 bytes。",
              "example": "{\"name\":\"xxx\",\"age\":\"xx\"}"
            }
          ]
        }
      ],
      "required": [
        "ReceiverId",
        "Datas"
      ]
    },
    {
      "name": "DeleteAddressUnsubscribeConfig",
      "description": "删除地址级退订配置",
      "status": "online",
      "parameters": [
        {
          "name": "Address",
          "type": "string",
          "required": false,
          "description": "需要操作的发信地址",
          "example": "test@example.com"
        }
      ],
      "required": []
    },
    {
      "name": "DeleteBlackList",
      "description": "邮箱被拉黑之后，用户如果确认收件邮箱有效或者已经处于激活状态，可以从腾讯云地址库中删除该黑名单之后继续投递。",
      "status": "online",
      "parameters": [
        {
          "name": "EmailAddressList",
          "type": "array",
          "required": true,
          "description": "需要清除的黑名单邮箱列表，数组长度至少为1",
          "example": "example@gmail.com",
          "item_type": "string"
        }
      ],
      "required": [
        "EmailAddressList"
      ]
    },
    {
      "name": "DeleteCustomBlackList",
      "description": "删除自定义黑名单邮箱地址",
      "status": "online",
      "parameters": [
        {
          "name": "Emails",
          "type": "array",
          "required": true,
          "description": "需要删除的邮箱地址",
          "example": "[\"a@mail.com\",\"b@mail.com\"]",
          "item_type": "string"
        }
      ],
      "required": [
        "Emails"
      ]
    },
    {
      "name": "DeleteEmailAddress",
      "description": "删除发信人地址",
      "status": "online",
      "parameters": [
        {
          "name": "EmailAddress",
          "type": "string",
          "required": true,
          "description": "发信地址",
          "example": "test@example.com"
        }
      ],
      "required": [
        "EmailAddress"
      ]
    },
    {
      "name": "DeleteEmailIdentity",
      "description": "删除发信域名，删除后，将不可再使用该域名进行发信",
      "status": "online",
      "parameters": [
        {
          "name": "EmailIdentity",
          "type": "string",
          "required": true,
          "description": "发信域名",
          "example": "example.com"
        }
      ],
      "required": [
        "EmailIdentity"
      ]
    },
    {
      "name": "DeleteEmailTemplate",
      "description": "删除发信模板",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateID",
          "type": "integer",
          "required": true,
          "description": "模板ID",
          "example": "10086"
        }
      ],
      "required": [
        "TemplateID"
      ]
    },
    {
      "name": "DeleteReceiver",
      "description": "根据收件id删除收件人列表,同时删除列表中的所有收件邮箱",
      "status": "online",
      "parameters": [
        {
          "name": "ReceiverId",
          "type": "integer",
          "required": true,
          "description": "收件人列表id，创建收件人列表时会返回",
          "example": "1"
        }
      ],
      "required": [
        "ReceiverId"
      ]
    },
    {
      "name": "GetAbuseReport",
      "description": "获取垃圾投诉数据",
      "status": "online",
      "parameters": [
        {
          "name": "StartTime",
          "type": "string",
          "required": true,
          "description": "起始时间",
          "example": "2025-10-14"
        },
        {
          "name": "EndTime",
          "type": "string",
          "required": true,
          "description": "结束时间",
          "example": "2025-10-15"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "限制数量（默认为1000）",
          "example": "10"
        },
        {
          "name": "FromDomain",
          "type": "string",
          "required": false,
          "description": "发信域名",
          "example": "qcloudmail.com"
        },
        {
          "name": "FromAddress",
          "type": "string",
          "required": false,
          "description": "发信地址",
          "example": "example@qcloudmail.com"
        },
        {
          "name": "Mta",
          "type": "string",
          "required": false,
          "description": "收信域名",
          "example": "gmail.com"
        },
        {
          "name": "ToAddress",
          "type": "string",
          "required": false,
          "description": "收信地址",
          "example": "example@gmail.com"
        },
        {
          "name": "TemplateId",
          "type": "string",
          "required": false,
          "description": "模版id",
          "example": "100"
        }
      ],
      "required": [
        "StartTime",
        "EndTime"
      ]
    },
    {
      "name": "GetEmailIdentity",
      "description": "获取某个发信域名的配置详情",
      "status": "online",
      "parameters": [
        {
          "name": "EmailIdentity",
          "type": "string",
          "required": true,
          "description": "发信域名",
          "example": "example.com"
        }
      ],
      "required": [
        "EmailIdentity"
      ]
    },
    {
      "name": "GetEmailTemplate",
      "description": "根据模板ID获取模板详情",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateID",
          "type": "integer",
          "required": true,
          "description": "模板ID",
          "example": "10091"
        }
      ],
      "required": [
        "TemplateID"
      ]
    },
    {
      "name": "GetSendEmailStatus",
      "description": "获取邮件发送状态。仅支持查询30天之内的数据",
      "status": "online",
      "parameters": [
        {
          "name": "RequestDate",
          "type": "string",
          "required": true,
          "description": "发送的日期，必填。仅支持查询某个日期，不支持范围查询。",
          "example": "2020-09-22"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量。默认为0",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "拉取最大条数，最多 100。",
          "example": "10"
        },
        {
          "name": "MessageId",
          "type": "string",
          "required": false,
          "description": "SendMail接口返回的MessageId字段。",
          "example": "qcloudses-30-4123414323-date-20210101094334-syNARhMTbKI1"
        },
        {
          "name": "ToEmailAddress",
          "type": "string",
          "required": false,
          "description": "收件人邮箱。",
          "example": "abc@ef.com"
        }
      ],
      "required": [
        "RequestDate",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "GetStatisticsReport",
      "description": "获取近期发送的统计情况，包含发送量、送达率、打开率、退信率等一系列数据。",
      "status": "online",
      "parameters": [
        {
          "name": "StartDate",
          "type": "string",
          "required": true,
          "description": "开始日期",
          "example": "2020-10-01"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": true,
          "description": "结束日期",
          "example": "2020-10-03"
        },
        {
          "name": "Domain",
          "type": "string",
          "required": false,
          "description": "发信域名",
          "example": "qcloud.com"
        },
        {
          "name": "ReceivingMailboxType",
          "type": "string",
          "required": false,
          "description": "收件方邮箱类型，例如gmail.com",
          "example": "gmail.com"
        }
      ],
      "required": [
        "StartDate",
        "EndDate"
      ]
    },
    {
      "name": "ListAddressUnsubscribeConfig",
      "description": "获取地址级退订配置列表",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "偏移量",
          "example": "0"
        },
        {
          "name": "Limit",
          "type": "string",
          "required": false,
          "description": "拉取最大条数，不超过100",
          "example": "10"
        }
      ],
      "required": []
    },
    {
      "name": "ListBlackEmailAddress",
      "description": "腾讯云发送的邮件一旦被收件方判断为硬退(Hard Bounce)，腾讯云会拉黑该地址，并不允许所有用户向该地址发送邮件。成为邮箱黑名单。如果业务方确认是误判，可以从黑名单中删除。",
      "status": "online",
      "parameters": [
        {
          "name": "StartDate",
          "type": "string",
          "required": true,
          "description": "开始日期，格式为YYYY-MM-DD",
          "example": "2023-09-01"
        },
        {
          "name": "EndDate",
          "type": "string",
          "required": true,
          "description": "结束日期，格式为YYYY-MM-DD",
          "example": "2023-09-02"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "规范，配合Offset使用",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "规范，配合Limit使用，Limit最大取值为100",
          "example": "0"
        },
        {
          "name": "EmailAddress",
          "type": "string",
          "required": false,
          "description": "可以指定邮箱进行查询",
          "example": "xx@gmail.com"
        },
        {
          "name": "TaskID",
          "type": "string",
          "required": false,
          "description": "已废弃",
          "example": "已废弃"
        }
      ],
      "required": [
        "StartDate",
        "EndDate",
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "ListCustomBlacklist",
      "description": "获取自定义黑名单列表",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，整型，从0开始",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "限制数目，整型,不超过100",
          "example": "10"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "筛选黑名单的状态，0:已过期，1:生效中, 2:全部",
          "example": "2"
        },
        {
          "name": "Email",
          "type": "string",
          "required": false,
          "description": "黑名单中的邮箱地址",
          "example": "a@mail.com"
        }
      ],
      "required": [
        "Offset",
        "Limit",
        "Status"
      ]
    },
    {
      "name": "ListEmailAddress",
      "description": "获取发信地址列表",
      "status": "online",
      "parameters": [],
      "required": []
    },
    {
      "name": "ListEmailIdentities",
      "description": "获取当前发信域名列表，包含已验证通过与未验证的域名",
      "status": "online",
      "parameters": [
        {
          "name": "TagList",
          "type": "array",
          "required": false,
          "description": "tag 标签",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "TagKey",
              "type": "string",
              "required": true,
              "description": "产品",
              "example": "tagkey"
            },
            {
              "name": "TagValue",
              "type": "string",
              "required": true,
              "description": "ses",
              "example": "tagvalue"
            }
          ]
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": false,
          "description": "分页 limit",
          "example": "100"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": false,
          "description": "分页 offset",
          "example": "10"
        }
      ],
      "required": []
    },
    {
      "name": "ListEmailTemplates",
      "description": "获取当前邮件模板列表",
      "status": "online",
      "parameters": [
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "获取模板数据量，用于分页",
          "example": "10"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "获取模板偏移值，用于分页",
          "example": "0"
        }
      ],
      "required": [
        "Limit",
        "Offset"
      ]
    },
    {
      "name": "ListReceiverDetails",
      "description": "根据收件人列表id查询收件人列表中的所有收件人邮箱地址，分页查询，可以根据收件邮箱地址来过滤查询",
      "status": "online",
      "parameters": [
        {
          "name": "ReceiverId",
          "type": "integer",
          "required": true,
          "description": "收件人列表ID,CreateReceiver接口创建收件人列表时会返回该值",
          "example": "1"
        },
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，整型，从0开始",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "限制数目，整型,不超过100",
          "example": "10"
        },
        {
          "name": "Email",
          "type": "string",
          "required": false,
          "description": "收件人地址，长度0-50，示例：xxx@te.com，支持模糊查询",
          "example": "test@example.com"
        },
        {
          "name": "CreateTimeBegin",
          "type": "string",
          "required": false,
          "description": "搜索开始时间",
          "example": "2024-08-13"
        },
        {
          "name": "CreateTimeEnd",
          "type": "string",
          "required": false,
          "description": "搜索结束时间",
          "example": "2024-08-14"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "1:有效，2:无效",
          "example": "1"
        }
      ],
      "required": [
        "ReceiverId",
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "ListReceivers",
      "description": "根据条件查询收件人列表，支持分页，模糊查询，状态查询",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，整型，从0开始",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "限制数目，整型，不超过100",
          "example": "10"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "列表状态(1 待上传 2 上传中 3传完成)，若查询所有就不传这个字段",
          "example": "1"
        },
        {
          "name": "KeyWord",
          "type": "string",
          "required": false,
          "description": "列表名称的关键字，模糊查询",
          "example": "列表名关键字"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "ListSendTasks",
      "description": "分页查询批量发送邮件任务，包含即时发送任务，定时发送任务，周期重复发送任务，查询发送情况，包括请求数量，已发数量，缓存数量，任务状态等信息",
      "status": "online",
      "parameters": [
        {
          "name": "Offset",
          "type": "integer",
          "required": true,
          "description": "偏移量，整型，从0开始，0代表跳过0行",
          "example": "1"
        },
        {
          "name": "Limit",
          "type": "integer",
          "required": true,
          "description": "限制数目，整型,不超过100",
          "example": "10"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": false,
          "description": "任务状态 1 待开始 5 发送中 6 今日暂停发送 7 发信异常 10 发送完成。查询所有状态，则不传这个字段",
          "example": "1"
        },
        {
          "name": "ReceiverId",
          "type": "integer",
          "required": false,
          "description": "收件人列表ID",
          "example": "1"
        },
        {
          "name": "TaskType",
          "type": "integer",
          "required": false,
          "description": "任务类型 1即时 2定时 3周期，查询所有类型则不传这个字段",
          "example": "1"
        }
      ],
      "required": [
        "Offset",
        "Limit"
      ]
    },
    {
      "name": "SendEmail",
      "description": "您可以通过此API发送HTML或者TEXT邮件，适用于触发类邮件（验证码、交易类）。默认仅支持使用模板发送邮件。",
      "status": "online",
      "parameters": [
        {
          "name": "FromEmailAddress",
          "type": "string",
          "required": true,
          "description": "发件人邮箱地址。不使用别名时请直接填写发件人邮箱地址，例如：noreply@mail.qcloud.com如需填写发件人别名时，请按照如下方式（注意别名与邮箱地址之间必须使用一个空格隔开）：别名+一个空格+，别名中不能带有冒号(:)。",
          "example": "QCLOUDTEAM \u0026ltnoreply@mail.qcloud.com\u0026gt"
        },
        {
          "name": "Subject",
          "type": "string",
          "required": true,
          "description": "邮件主题",
          "example": "YourTestSubject"
        },
        {
          "name": "Destination",
          "type": "array",
          "required": false,
          "description": "收信人邮箱地址，最多支持群发50人。注意：邮件内容会显示所有收件人地址，非群发邮件请多次调用API发送。 Destination/Cc/Bcc三个参数必须至少存在一个。",
          "example": "[\"destination@mail.qcloud.com\"]",
          "item_type": "string"
        },
        {
          "name": "ReplyToAddresses",
          "type": "string",
          "required": false,
          "description": "邮件的“回复”电子邮件地址。可以填写您能收到邮件的邮箱地址，可以是个人邮箱。如果不填，收件人的回复邮件将会发送失败。",
          "example": "noreply@mail.qcloud.com"
        },
        {
          "name": "Cc",
          "type": "array",
          "required": false,
          "description": "抄送人邮箱地址，最多支持抄送20人。",
          "example": "[\"cc@mail.qcloud.com\"]",
          "item_type": "string"
        },
        {
          "name": "Bcc",
          "type": "array",
          "required": false,
          "description": "密送人邮箱地址，最多支持抄送20人,Bcc和Destination不能重复。",
          "example": "[\"bcc@mail.qcloud.com\"]",
          "item_type": "string"
        },
        {
          "name": "Template",
          "type": "object",
          "required": false,
          "description": "使用模板发送时，填写模板相关参数。 如您未申请过特殊配置，则该字段为必填",
          "example": "无",
          "children": [
            {
              "name": "TemplateID",
              "type": "integer",
              "required": true,
              "description": "模板ID。如果没有模板，请先新建一个",
              "example": "1"
            },
            {
              "name": "TemplateData",
              "type": "string",
              "required": true,
              "description": "模板中的变量参数，请使用json.dump将json对象格式化为string类型。该对象是一组键值对，每个Key代表模板中的一个变量，模板中的变量使用{{键}}表示，相应的值在发送时会被替换为{{值}}。 注意：参数值不能是html等复杂类型的数据。 示例：{\"name\":\"xxx\",\"age\":\"xx\"}",
              "example": "{\"name\":\"andy\",\"age\":\"24\"}"
            }
          ]
        },
        {
          "name": "Simple",
          "type": "object",
          "required": false,
          "description": "已废弃 仅部分历史上申请了特殊配置的客户需要使用。如您未申请过特殊配置，则不存在该字段。",
          "example": "无",
          "children": [
            {
              "name": "Html",
              "type": "string",
              "required": false,
              "description": "base64之后的Html代码。需要包含所有的代码信息，不要包含外部css，否则会导致显示格式错乱",
              "example": "PGh0bWw+PGhlYWQ+PHRpdGxlPkV4YW1wbGUgSFRNTDwvdGl0bGU+PC9oZWFkPjxib2R5PjxwPkhlbGxvLCB3b3JsZDwvcD48L2JvZHk+PC9odG1sPg=="
            },
            {
              "name": "Text",
              "type": "string",
              "required": false,
              "description": "base64之后的纯文本信息，如果没有Html，邮件中会直接显示纯文本；如果有Html，它代表邮件的纯文本样式",
              "example": "SGVsbG8sIHdvcmxkIQ=="
            }
          ]
        },
        {
          "name": "Attachments",
          "type": "array",
          "required": false,
          "description": "需要发送附件时，填写附件相关参数。腾讯云接口请求最大支持 8M 的请求包，附件内容经过 Base64 预期扩大1.5倍，应该控制所有附件的总大小最大在 4M 以内，整体请求超出 8M 时接口会返回错误",
          "example": "无",
          "item_type": "object",
          "children": [
            {
              "name": "FileName",
              "type": "string",
              "required": true,
              "description": "附件名称，最大支持255个字符长度，不支持部分附件类型，详情请参考[附件类型](https://cloud.tencent.com/document/product/1288/51951)。",
              "example": "example.txt"
            },
            {
              "name": "Content",
              "type": "string",
              "required": false,
              "description": "Base64之后的附件内容，您可以发送的附件大小上限为4M。注意：腾讯云接口请求最大支持 8M 的请求包，附件内容经过 Base64 预期扩大1.5倍。应该控制所有附件的总大小最大在 4M 以内，整体请求超出 8M 接口会返回错误。",
              "example": "dGhpcyBpcyBhIGV4YW1wbGU="
            },
            {
              "name": "FileURL",
              "type": "string",
              "required": false,
              "description": "附件URL。未开放功能，请勿使用。",
              "example": "https://www.test.com/1.png"
            }
          ]
        },
        {
          "name": "Unsubscribe",
          "type": "string",
          "required": false,
          "description": "退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语",
          "example": "1"
        },
        {
          "name": "TriggerType",
          "type": "integer",
          "required": false,
          "description": "邮件触发类型 0:非触发类，默认类型，营销类邮件、非即时类邮件等选择此类型 1:触发类，验证码等即时发送类邮件，若邮件超过一定大小，系统会自动选择非触发类型通道",
          "example": "1"
        },
        {
          "name": "SmtpMessageId",
          "type": "string",
          "required": false,
          "description": "smtp头中的Message-Id字段",
          "example": "\u003c2SNZPF1T2NU4.5OB8TNNRVRYM3@qcloudmail.com\u003e"
        },
        {
          "name": "SmtpHeaders",
          "type": "string",
          "required": false,
          "description": "smtp头中可以设置的其它字段",
          "example": "{\"header1\": \"value1\", \"header2\": \"value2\"}"
        },
        {
          "name": "HeaderFrom",
          "type": "string",
          "required": false,
          "description": "smtp头中的from字段，建议域名与FromEmailAddress保持一致",
          "example": "noreply@mail.qcloud.com"
        }
      ],
      "required": [
        "FromEmailAddress",
        "Subject"
      ]
    },
    {
      "name": "UpdateAddressUnsubscribeConfig",
      "description": "用于更新地址级退订配置",
      "status": "online",
      "parameters": [
        {
          "name": "Address",
          "type": "string",
          "required": true,
          "description": "发信地址",
          "example": "test@example.com"
        },
        {
          "name": "UnsubscribeConfig",
          "type": "string",
          "required": true,
          "description": "退订链接选项 0: 不加入退订链接 1: 简体中文 2: 英文 3: 繁体中文 4: 西班牙语 5: 法语 6: 德语 7: 日语 8: 韩语 9: 阿拉伯语 10: 泰语",
          "example": "0"
        },
        {
          "name": "Status",
          "type": "integer",
          "required": true,
          "description": "0:关闭配置，1:打开配置",
          "example": "1"
        }
      ],
      "required": [
        "Address",
        "UnsubscribeConfig",
        "Status"
      ]
    },
    {
      "name": "UpdateCustomBlackList",
      "description": "更新自定义黑名单",
      "status": "online",
      "parameters": [
        {
          "name": "Id",
          "type": "integer",
          "required": true,
          "description": "需要更改的黑名单id",
          "example": "1"
        },
        {
          "name": "Email",
          "type": "string",
          "required": true,
          "description": "修改后的邮件地址",
          "example": "a@mail.com"
        },
        {
          "name": "ExpireDate",
          "type": "string",
          "required": false,
          "description": "过期时间，为空则表示永久有效",
          "example": "2024-06-19"
        }
      ],
      "required": [
        "Id",
        "Email"
      ]
    },
    {
      "name": "UpdateEmailIdentity",
      "description": "您已经成功配置好了您的DNS，接下来请求腾讯云验证您的DNS配置是否正确",
      "status": "online",
      "parameters": [
        {
          "name": "EmailIdentity",
          "type": "string",
          "required": true,
          "description": "请求验证的域名",
          "example": "example.com"
        }
      ],
      "required": [
        "EmailIdentity"
      ]
    },
    {
      "name": "UpdateEmailSmtpPassWord",
      "description": "设置邮箱的smtp密码。若要通过smtp发送邮件，必须为邮箱设置smtp密码。初始时，邮箱没有设置smtp密码，不能使用smtp的方式发送邮件。设置smtp密码后，可以修改密码。",
      "status": "online",
      "parameters": [
        {
          "name": "Password",
          "type": "string",
          "required": true,
          "description": "smtp密码，长度限制64",
          "example": "yourPassword"
        },
        {
          "name": "EmailAddress",
          "type": "string",
          "required": true,
          "description": "发信邮箱,长度限制128",
          "example": "address@example.com"
        }
      ],
      "required": [
        "Password",
        "EmailAddress"
      ]
    },
    {
      "name": "UpdateEmailTemplate",
      "description": "更新邮件模板，更新后需再次审核",
      "status": "online",
      "parameters": [
        {
          "name": "TemplateContent",
          "type": "object",
          "required": true,
          "description": "模板内容",
          "example": "无",
          "children": [
            {
              "name": "Html",
              "type": "string",
              "required": false,
              "description": "base64之后的Html代码",
              "example": "PGh0bWw+PGhlYWQ+PHRpdGxlPkV4YW1wbGUgSFRNTDwvdGl0bGU+PC9oZWFkPjxib2R5PjxwPkhlbGxvLCB3b3JsZDwvcD48L2JvZHk+PC9odG1sPg=="
            },
            {
              "name": "Text",
              "type": "string",
              "required": false,
              "description": "base64之后的文本内容",
              "example": "SGVsbG8sIHdvcmxkIQ=="
            }
          ]
        },
        {
          "name": "TemplateID",
          "type": "integer",
          "required": true,
          "description": "模板ID",
          "example": "10091"
        },
        {
          "name": "TemplateName",
          "type": "string",
          "required": true,
          "description": "模板名字",
          "example": "myTemplateName"
        }
      ],
      "required": [
        "TemplateContent",
        "TemplateID",
        "TemplateName"
      ]
    }
  ]
}