# Webhook事件说明
# 请求事件 ( request )
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| event | string | 事件类型:"request" |
| message | string | 消息内容 |
| maillistTaskId | long | 如果使用地址列表发送，将产生任务id |
| mail_list_task_id | long | 同 maillistTaskId |
| messageId | string | messageId |
| apiUser | string | API_USER |
| category | string | 同 apiUser |
| recipientArray | list | 请求的收件人 |
| emailIds | list | emailId 数组 |
| labelId | int | 自定义的标签ID |
| labelName | string | 自定义的标签名称 |
| recipientSize | int | 本次请求的个数 |
| timestamp | long | 时间戳，事件产生时间 |
| token | string | 随机产生的长度为50的字符串 |
| signature | string | 签名字符串 |
| userHeaders | string | 用户自定义, 并且以"SC-Custom-"开头的头部信息 |
# 发送 ( deliver )
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| event | string | 事件类型:"deliver" |
| message | string | 消息内容 |
| apiUser | string | API_USER |
| category | string | 同 apiUser |
| maillistTaskId | long | 如果使用地址列表发送，将产生任务id |
| mail_list_task_id | long | 同 maillistTaskId |
| emailId | string | 每封email的唯一ID |
| outIp | string | 出信IP地址 |
| recipient | string | 收信人 |
| labelId | int | 自定义的标签ID |
| labelName | string | 自定义的标签名称 |
| timestamp | long | 时间戳，事件产生时间 |
| token | string | 随机产生的长度为50的字符串 |
| signature | string | 签名字符串 |
| userHeaders | string | 用户自定义, 并且以"SC-Custom-"开头的头部信息 |
# 打开 ( open )
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| event | string | 事件类型:"open" |
| message | string | 消息内容 |
| apiUser | string | API_USER |
| category | string | 同 apiUser |
| maillistTaskId | long | 如果使用地址列表发送，将产生任务id |
| mail_list_task_id | long | 同 maillistTaskId |
| emailId | string | 每封email的唯一ID |
| recipient | string | 收信人 |
| labelId | int | 自定义的标签ID |
| labelName | string | 自定义的标签名称 |
| ip | string | 打开的Ip地址 |
| explorerName | string | 浏览器名称 |
| explorerVer | string | 浏览器版本 |
| oSName | string | 操作系统名称 |
| oSVer | string | 操作系统版本 |
| timestamp | long | 时间戳，事件产生时间 |
| token | string | 随机产生的长度为50的字符串 |
| signature | string | 签名字符串 |
| userHeaders | string | 用户自定义, 并且以"SC-Custom-"开头的头部信息 |
# 点击 ( click )
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| event | string | 事件类型:"click" |
| message | string | 消息内容 |
| apiUser | string | API_USER |
| category | string | 同 apiUser |
| maillistTaskId | long | 如果使用地址列表发送，将产生任务id |
| mail_list_task_id | long | 同 maillistTaskId |
| emailId | string | 每封email的唯一ID |
| recipient | string | 收信人 |
| labelId | int | 自定义的标签ID |
| labelName | string | 自定义的标签名称 |
| url | string | 被点击的链接 |
| ip | string | 点击的Ip地址 |
| explorerName | string | 浏览器名称 |
| explorerVer | string | 浏览器版本 |
| oSName | string | 操作系统名称 |
| oSVer | string | 操作系统版本 |
| timestamp | long | 时间戳，事件产生时间 |
| token | string | 随机产生的长度为50的字符串 |
| signature | string | 签名字符串 |
| userHeaders | string | 用户自定义, 并且以"SC-Custom-"开头的头部信息 |
# 取消订阅 ( unsubscribe )
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| event | string | 事件类型:"unsubscribe" |
| message | string | 消息内容 |
| apiUser | string | API_USER |
| category | string | 同 apiUser |
| labelId | int | 自定义的标签ID |
| labelName | string | 自定义的标签名称 |
| maillistTaskId | long | 如果使用地址列表发送，将产生任务id |
| mail_list_task_id | long | 同 maillistTaskId |
| emailId | string | 每封email的唯一ID |
| recipient | string | 收信人 |
| ip | string | Ip地址 |
| explorerName | string | 浏览器名称 |
| explorerVer | string | 浏览器版本 |
| oSName | string | 操作系统名称 |
| oSVer | string | 操作系统版本 |
| timestamp | long | 时间戳，事件产生时间 |
| token | string | 随机产生的长度为50的字符串 |
| signature | string | 签名字符串 |
| userHeaders | string | 用户自定义, 并且以"SC-Custom-"开头的头部信息 |
# 垃圾举报 ( report_spam )
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| event | string | 事件类型:"report_spam" |
| message | string | 消息内容 |
| apiUser | string | API_USER |
| category | string | 同 apiUser |
| labelId | int | 自定义的标签ID |
| labelName | string | 自定义的标签名称 |
| emailId | string | 每封email的唯一ID |
| recipient | string | 收信人 |
| timestamp | long | 时间戳，事件产生时间 |
| token | string | 随机产生的长度为50的字符串 |
| signature | string | 签名字符串 |
| userHeaders | string | 用户自定义, 并且以"SC-Custom-"开头的头部信息 |
# 无效邮件 ( invalid )
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| event | string | 事件类型:"invalid" |
| message | string | 消息内容 |
| apiUser | string | API_USER |
| category | string | 同 apiUser |
| labelId | int | 自定义的标签ID |
| labelName | string | 自定义的标签名称 |
| maillistTaskId | long | 如果使用地址列表发送，将产生任务id |
| mail_list_task_id | long | 同 maillistTaskId |
| emailId | string | 每封email的唯一ID |
| outIp | string | 出信IP地址 |
| recipient | string | 收信人 |
| timestamp | long | 时间戳，事件产生时间 |
| token | string | 随机产生的长度为50的字符串 |
| signature | string | 签名字符串 |
| userHeaders | string | 用户自定义, 并且以"SC-Custom-"开头的头部信息 |
| subStatDesc | string | 无效子类描述,eg：IP、域名被拒(5.7.1 Unfortunately, messages...protection.outlook.com]) |
| subStat | Integer | 无效子类,eg: 405 |
无效子类返回码和描述：
| subStat | subStatDesc |
|---|---|
| 401 | 在SendCloud黑名单中 |
| 402 | 取消订阅 |
| 403 | 服务器不可达 |
| 404 | 地址格式错误 |
| 405 | IP、域名被拒 |
| 406 | 地址不存在 |
| 407 | 垃圾邮件 |
| 408 | 发件人/收件人被拒 |
| 409 | 其他 |
# 软退信 ( soft_bounce )
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| event | string | 事件类型:"soft_bounce" |
| apiUser | string | API_USER |
| category | string | 同 apiUser |
| labelId | int | 自定义的标签ID |
| maillistTaskId | long | 如果使用地址列表发送，将产生任务id |
| mail_list_task_id | long | 同 maillistTaskId |
| emailId | string | 每封email的唯一ID |
| outIp | string | 出信IP地址 |
| recipient | string | 收信人 |
| timestamp | long | 时间戳，事件产生时间 |
| token | string | 随机产生的长度为50的字符串 |
| signature | string | 签名字符串 |
| userHeaders | string | 用户自定义, 并且以"SC-Custom-"开头的头部信息 |
| subStatDesc | string | 软退信子类描述,eg：其他(DIAGNOSTIC-CODE...83.) |
| subStat | Integer | 软退信子类,eg: 409 |
| cause | string | 原始软退信明细信息,eg: DIAGNOSTIC-CODE: smtp; Your email to group .....https://support.google.com/a/answer/168383. |
软退信子类返回码和描述：
| subStat | subStatDesc |
|---|---|
| 503 | 服务不可达 |
| 505 | ip或域名被拒 |
| 506 | 邮箱地址不存在 |
| 507 | 垃圾邮件 |
| 508 | 发件人/收件人被拒 |
| 509 | 其他 |
# 转信 ( route )
参数说明
| 参数 | 类型 | 说明 |
|---|---|---|
| event | string | 事件类型:"route" |
| message | string | 消息内容 "mx route" |
| timestamp | long | 时间戳 |
| from | string | 邮件标头发件人，声称发件人地址，显示在正文的发件人 |
| fromname | string | 发件人名称 |
| to | string | 邮件标头收件人 |
| toname | string | 收件人名称 |
| x_mx_mailfrom | string | 信封发件人，实际发件人 |
| x_mx_rcptto | string | 实际收件人地址 |
| headers | string | 邮件头部信息. JSON 格式 |
| html | string | 转信邮件 html 格式的内容 |
| text | string | 转信邮件文本格式的内容 |
| subject | string | 标题 |
| raw_message_url | string | 转信文件下载. eg：https:xxx.eml，链接有效期为15天 |
| raw_message | string | 邮件原文 |
| token | string | 随机产生的长度为50的字符串 |
| signature | string | 签名字符串 |
| userHeaders | string | 客户调用发送接口自定义的, 并且以"SC-Custom-"开头的头部信息 |
| reference | string | 如果有值，为： SendCloud发出邮件的Message-ID |
| emailId | string | 父邮件的唯一id. 通过此字段，回复邮件可与父邮件进行关联。此值从reference和In-Reply-To中解析 |
| labelId | int | 父邮件自定义的标签ID |
| labelName | string | 父邮件自定义的标签名称 |
Note:
- 当您未传入自定义的Message-ID时，reference中的Message-ID按平台规则自动生成，Message-ID的前缀与emailid的前缀相同。当您通过SMTP请求传入自定义的Message-ID时，reference中的Message-ID将为您传入的Message-ID。当回复邮件匹配不上父邮件时，会为空。
- eg："reference"："1644468027883_1024_25239_6195.sg-10_1_253_1-inbound0@ifaxin.com" #ifaxin.com为发信域名
- java解析eml文件示例 ，点此下载