WebHook

WebHook是SendCloud异步推送客户关注某些事件的数据到客户的回调URL上的机制.规则详见开发者指南-高级功能-WebHook

你可以使用以下 API 对回调URL进行查询, 添加, 更新, 删除操作.

查询WebHook

URL

https://api.sendcloud.net/apiv2/webhook/list

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
url	string	否	所产生的消息Post到Url
categoryName	string	否	指定的API_USER
event	string	否	事件类型，比如1，3多个用逗号隔开，不填写默认全部

event参数说明

event	描述	触发条件
1	送达(Delivered)	邮件发送成功
3	垃圾邮件举报(report_spam)	用户举报邮件
4	无效邮件(Invalid)	邮件未发送成功
5	软退信(Soft Bounce)	接收方拒收该邮件
10	点击(Click)	用户点击链接
11	打开(Open)	用户打开邮件
12	取消订阅(Unsubcribes)	用户取消订阅邮件
18	请求(Request)	邮件请求成功

创建WebHook

URL

https://api.sendcloud.net/apiv2/webhook/add

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
url	string	是	所产生的消息Post到Url
categoryName	string	是	指定的API_USER或all
event	string	是	事件类型，比如1，3多个用逗号隔开

更新WebHook

URL

https://api.sendcloud.net/apiv2/webhook/update

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
url	string	是	所产生的消息Post到Url
categoryName	string	是	指定的API_USER或all
event	string	是	事件类型，比如1，3多个用逗号隔开
newCategoryName	string	*	新的指定的API_USER
newUrl	string	*	新的消息推送Url
newEvent	string	*	新的触发webhook推送的事件

说明

1. *代表可以仅修改apiuser、事件、url中的一项，均不可修改为空值.

删除WebHook

URL

https://api.sendcloud.net/apiv2/webhook/delete

HTTP请求方式

post    get

参数说明

参数	类型	必须	说明
apiUser	string	是	API_USER
apiKey	string	是	API_KEY
url	string	是	所产生的消息Post到Url
categoryName	string	是	指定的API_USER或all
event	string	是	事件类型，比如1，3多个用逗号隔开

请求示例

http://api.sendcloud.net/apiv2/webhook/list?apiUser=***&apiKey=***

通用返回值说明

参数	说明
eventTypeMap	事件集合列表
categoryName	apiUser名称
webhookUrl	回调url

通用事件的参数说明

参数	事件	触发条件
1	送达(Delivered)	邮件发送成功
3	垃圾邮件举报(report_spam)	用户举报邮件
4	无效邮件(Invalid)	邮件未发送成功
5	软退信(Soft Bounce)	接收方拒收该邮件
10	点击(Click)	用户点击链接
11	打开(Open)	用户打开邮件
12	取消订阅(Unsubcribes)	用户取消订阅邮件
18	请求(Request)	邮件请求成功

返回值示例

{
    "result": true,
    "statusCode": 200,
    "message": "请求成功",
    "info": {
        "dataList": [
            {
                "webhookUrl": "http://qxxx.com",
                "eventTypeMap": {
                    "11": "打开"
                },
                "categoryName": "jianglian_test"
            },
            {
                "webhookUrl": "http://sina12345.com",
                "eventTypeMap": {
                    "11": "打开"
                },
                "categoryName": "all"
            },
            {
                "webhookUrl": "http://hhh.com",
                "eventTypeMap": {
                    "1": "发送",
                    "3": "垃圾邮件举报",
                    "4": "无效邮件",
                    "5": "退信",
                    "10": "点击",
                    "11": "打开",
                    "12": "取消订阅",
                    "18": "请求"
                },
                "categoryName": "jianglian_test"
            },
            {
                "webhookUrl": "http://wbw888.com",
                "eventTypeMap": {
                    "18": "请求"
                },
                "categoryName": "all"
            },
            {
                "webhookUrl": "http://hh123.com",
                "eventTypeMap": {
                    "18": "请求"
                },
                "categoryName": "all"
            },
            {
                "webhookUrl": "http://sina1234.com",
                "eventTypeMap": {
                    "4": "无效邮件"
                },
                "categoryName": "jianglian_test"
            }
        ],
        "count": 6
    }
}