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"
from	string	发件人地址
fromname	string	发件人名称
headers	string	邮件头部信息. JSON 格式
html	string	转信邮件 html 格式的内容
message	string	消息内容 "mx route"
raw_message_url	string	转信文件下载. eg：https:xxx.eml，链接有效期为15天
signature	string	签名字符串
subject	string	标题
text	string	转信邮件文本格式的内容
timestamp	long	时间戳，事件产生时间
to	string	收件人地址
token	string	随机产生的长度为50的字符串
toname	string	收件人名称
userHeaders	string	用户自定义, 并且以"SC-Custom-"开头的头部信息
reference	string	回复邮件和其父邮件的关联字段，如果有值， 由'父邮件的messageID值'+'数字'+'@发信域名' 组成
emailId	string	父邮件的唯一id. 通过此字段，回复邮件可与父邮件进行关联。此值是否有值，取决于收信端的回复邮件是否带有reference头字段

Tips:

1. 如果reference有值，格式为：SendCloud发出邮件的messageID（emailId $符号之前的部分）和 '@发信域名' 组成. eg："reference"："1644468027883_1024_25239_6195.sg-10_1_253_1-inbound0@ifaxin.com" #ifaxin.com为发信域名
2. reference的前缀和emailid的前缀是一样的，都是取自messageID.
3. 客户可通过reference和邮件地址拼接组成，得到父邮件的emailID.

java解析eml文件示例 ，点此下载

POST 数据示例

maillistTaskId=-1&signature=eb6484eb14a429f7ea367647ffc9bc617ac8ce858afa2705d247f21177760ded&mail_list_task_id=-1&emailId=1576829271482_66557_24087_8851.sc-10_9_13_218-inbound0%24allsa%40sendcloud.cn&message=Successfully+delivered&apiUser=51eat_trigger&token=34szcNvC15W8wxLr1dONdBEuCfn4n4DpxHooDAkGMJf5pG2zVP&userHeaders=%7B%7D&labelId=0&recipient=allsa%40sendcloud.cn&event=deliver&category=51eat_trigger&timestamp=1576829272783