一、回调配置
设置回调地址后,腾讯云将在产生“递送成功、腾讯云拒信、ESP 退信、用户打开邮件、点击链接、退订”等事件后通知到回调地址。通过邮件推送控制台,你可以配置回调地址的操作,请参见 回调地址。同一封邮件,部分事件可能有多次回调,如果收件人多次打开邮件,便会产生多次打开事件的回调。
二、请求示例
{ "event":"bounce", "email":"example@example.com", "bulkId":"qcloudses-30-251200670-date-20220601142439-8jolHvR2XcXC1", "timestamp":1654064683, "reason":"551 5.1.1 recipient is not exist", "bounceType":"hard_bounce", "username":"251200670", "from":"test@fromexample.com", "fromDomain":"fromexample.com", "templateId":123456, "subject":"example subject", "messageId":"ea2783c1-7704-48a8-af36-2b9e83e767ec@fromexample.com", "sentTimestamp":1761555487, "X-Tencentcloudses-Cb-Custom":"ses callback"}
| 字段 | 类型 | 描述 |
| event | string | 事件类型,详情请参见 事件类型。 |
| string | 收件人地址。 | |
| link | string | 用户点击的邮件中的链接 URL,仅在event="click"时生效。 |
| bulkId | string | SendEmail 接口返回的 MessageId。 |
| timestamp | int | 事件产生的时间戳。 |
| reason | string | 邮件递送失败的原因。 |
| bounceType | string | 如果收件人邮件服务商拒信,拒信类型,取值:soft_bounce | hard_bounce,仅在event="bounce"的时候生效。 |
| username | string | 腾讯云账号对应的 AppID。 |
| from | string | 发信地址(不带发件人别名)。 |
| fromDomain | string | 发信域名。 |
| templateId | int | 模板 ID。 |
| useragent | string | 用户代理提供有关用于访问邮件的设备、操作系统和浏览器的信息,仅对 Open 和 Click 事件生效。 |
| subject | string | 邮件主题,若包含非 ASCII 字符(例如中文),则会使用 MIME 编码进行转义。 |
| messageId | string | SMTP 协议头中的 Message-ID,用户在使用 SMTP 或 API 发送时可以传自已定义的邮件唯一标识符,注意这个一定要能够唯一标识一封邮件且符合 RFC5322标准。 |
| eventid | int | 1:delivered2:dropped3:bounce4:open5:click6:spamreport7:unsubscribe8:deferred |
| taskId | int | 批量发送任务的 taskId。 |
| sentTimestamp | int | 发送时间戳 |
| X-Tencentcloudses-Cb- | string | 在邮件头中设置以"X-Tencentcloudses-Cb-"为前缀的自定义内容,支持在api、smtp发送中设置。api发送可以通过接口SendEmail的参数SmtpHeaders设置。 |
三、事件类型
| Value | Description |
| deferred | 邮件被收件人邮件服务商延迟传递,正在重试中 |
| delivered | 递送成功,收件人邮件服务商已接收此邮件 |
| dropped | 因为某种原因,这封邮件不能送达,被丢弃 |
| open | 收件人打开了此邮件 |
| click | 收件人点击了此邮件中的链接 |
| bounce | 收件人邮件服务商拒收此邮件(一般是因为邮箱地址错误) |
| spamreport | 收件人举报了此邮件 |
| unsubscribe | 收件人点击了业务方的“退订”按钮,需要业务方在退订链接中包含"unsubscribe"关键词 |