• 新建webhook页面

与GMP的webhook对接，您需要开发一个HTTP Server。注意是POST请求

Request Body是一个list(一次最多发送50条),结构如下,可以将多个用户的触发合并在一个请求中。对于任何类型的数据(如整数，小数，日期等类型)，在发送请求时，所有的字段全部转为字符串进行处理

请求样例

用户属性

• 用户属性列表来源是CDP造数中创建的所有用户属性。

可选的模板参数类型

Webhook POST请求中的Body结构

[{ 
    "user_profile":{ 
        "target_type":"phoneid", 
        "target_id":"13422145048" 
    }, 
    "params":{ 
        "key":"value",

        "CustomizedTemplate":{ // 自定义模板部分
            "CustomizedTemplateDesc":{ 
                "applyInfo":"123", 
                "code":"1", 
                "content":"验证码为${code}", 
                "createTime":"1648032613645", 
                "id":"1",
                "name":"n1", 
                "relatedAccountNum":"123", 
                "relatedProductNum":"123", 
                "signature":"123", 
                "smsType":"0", 
                "updateTime":"1648119013645" 
            }, 
            "CustomizedTemplateParams":{ 
                "code":"code_val" 
            }
        }
    }, 
    "server_str":"{\"log_id\":\"1016485613913050009950000000000MTM0MjIxNDUwNDg=9ed53f_69184\",\"task_id\":\"2453\",\"sub_task_id\":\"11754\",\"webhook_id\":281,\"task_type\":\"task\",\"log_str\":\"MXx8MjQ1M3wxMTc1NHwxMTc1NHx0YXNrfDEzNDIyMTQ1MDQ4fHwxMzQyMjE0NTA0OHxwaG9uZWlkfHBob25laWR8MjgxfHdlYmhvb2t8\"}" 
}]

样例

Webhook样例

请求体样例

[{ 
    "user_profile":{ 
        "target_type":"web_id", 
        "target_id":"13422145048" 
    }, 
    "params":{ 
        "city": "北京", //用户属性中的city,会在gmp后台获取到对应的属性，前端页面不展示
        "http": "xxx", //模板参数里面的http
        "CustomizedTemplate":{ // 自定义模板部分
            "CustomizedTemplateDesc":{ 
                "applyInfo":"123", 
                "code":"1", 
                "content":"验证码为${code}", 
                "createTime":"1648032613645", 
                "id":"1", "name":"n1", 
                "relatedAccountNum":"123", 
                "relatedProductNum":"123", 
                "signature":"123", 
                "smsType":"0", 
                "updateTime":"1648119013645" 
            }, 
            "CustomizedTemplateParams":{ 
                "code":"code_val",
                "dsce1":"xxx"
            }
        }
    }, 
    "server_str":"{\"log_id\":\"1016485613913050009950000000000MTM0MjIxNDUwNDg=9ed53f_69184\",\"task_id\":\"2453\",\"sub_task_id\":\"11754\",\"webhook_id\":281,\"task_type\":\"task\",\"log_str\":\"MXx8MjQ1M3wxMTc1NHwxMTc1NHx0YXNrfDEzNDIyMTQ1MDQ4fHwxMzQyMjE0NTA0OHxwaG9uZWlkfHBob25laWR8MjgxfHdlYmhvb2t8\"}" 
}]

触达任务页面展示样例

回执上报

单条上报

HTTP请求URL:

POST请求
http://${gmp_host}:${gmp_port}/gmp/webhook

body:

//v2.8-2.10
{
    "log_id": "xxxx",
    "log_str": "xxxx",
    "receipt_code": 3000,
 }

//v2.11
{
    "log_id": "xxxx",
    "log_str": "xxxx",
    "receipt_code": 3000,
    "receipt_message": "xxxx",
    "extra": "xxx",
    "receipt_time": 1634010444, //事件发生的时间戳，秒级
    "request_id": "xxxx" //每次请求唯一，该id一致当做一次请求，基于该id去重
}

• receipt_code:3000 到达成功

• receipt_code:3001 用户点击

• receipt_code:4000 发送失败

server_str的字段(用于做回执上报):

"server_str": "{\"log_id\":\"logId1111\",\"task_id\":\"11\",\"sub_task_id\":\"0\",\"batch_id\":\"fbe352\",\"webhook_id\":\"14\",\"task_type\":\"task\",log_str:\"xxxx\"}"

server_str字段解析

Response

{
    "code":0,
    "message":"success" //数据接收成功
}


{
    "code": 1002, //数据接收失败
    "message": "request params error" //参数错误
}

批量上报

v2.10版本支持
HTTP请求URL:

POST请求
http://${gmp_host}:${gmp_port}/gmp/webhookList

body:

[{
    "log_id": "xxxx",
    "log_str": "xxxx",
    "receipt_code": 3000,
    "receipt_message": "xxxx",
    "extra": "xxx",
    "receipt_time": 1634010444, //事件发生的时间戳，秒级
    "request_id": "xxxx"  //每次请求唯一，该id一致当做一次请求，基于该id去重
},
{
    "log_id": "xxxx",
    "log_str": "xxxx",
    "receipt_code": 3000,
    "receipt_message": "xxxx",
    "extra": "xxx",
    "receipt_time": 1634010444, //事件发生的时间戳，秒级
    "request_id": "xxxx"
},
{
    "log_id": "xxxx",
    "log_str": "xxxx",
    "receipt_code": 3000,
    "receipt_message": "xxxx",
    "extra": "xxx",
    "receipt_time": 1634010444, //事件发生的时间戳，秒级
    "request_id": "xxxx"
}]

Response

{
    "code":0,
    "err_data":[] //数据都接收成功
}

//假设上报了三条数据，第1，3条数据上报失败，第2条成功
{
    "code": -1, //数据接收失败
    "err_data": [ //上报失败的数据列表
        {
            "message": "request params error",
            "code": 1002, //批量请求第一条数据错误
            "index": 1
        },
        {
            "message": "system error",
            "code": 1000, //批量请求第三条数据错误
            "index": 3
        }
    ]
}

由于新建Webhook通道的时候可以选择鉴权方式

密钥

• 用户填写密钥，在GMP内部会根据用户填写的密钥与Request Body进行HmacSHA1签名并生成

signature，并将此signature通过Request Header传递过去来做鉴权，您的服务接受到请求后，同样根据Request Body(后续版本会有增加字段的可能，需要根据收到的Request Body数据计算签名，再解析数据)与webhook通道配置的密钥进行HmacSHA1算法加密，如果计算的值与从Request Header中传过来的signature相同，则可以确定是此请求是从GMP中发送的。

签名算法示例

• go语言生成签名的代码示例

func HmacSHA1(secretKey string, requestBody string) string {
   mac := hmac.New(sha1.New, []byte(key))
   mac.Write([]byte(data))
   return hex.EncodeToString(mac.Sum(nil))
}

• Java语言生成签名的代码示例

public String HmacSHA1(String secretKey,String requestBody) throws Exception {
    byte[] data = secretKey.getBytes("utf-8");
    SecretKey sk = new SecretKeySpec(data, "HmacSHA1");
    Mac mac = Mac.getInstance("HmacSHA1");
    mac.init(sk);
    byte[] text = requestBody.getBytes("utf-8");
    return Hex.encodeHexString(mac.doFinal(text));
}

需要从maven中引入依赖

<dependency>
    <groupId>commons-codec</groupId>
    <artifactId>commons-codec</artifactId>
    <version>1.15</version>
</dependency>

签名前

Request Body

[{
    "user_profile": {
        "target_type": "mobile",
        "target_id": "13333333333"
    },
    "params": {
        "string": "string",
        "text": "用户所在的地址是北京",
        "datetime": "2019-08-08",
        "integer": "123",
        "decimal": "158.123",
        "percentage": "18.5"
    }
}, {
    "user_profile": {
        "target_type": "mobile",
        "target_id": "13222222222"
    },
    "params": {
        "string": "string",
        "text": "用户所在的地址是天津",
        "datetime": "2019-08-08",
        "integer": "123",
        "decimal": "158.123",
        "percentage": "18.5"
    }
}]

SecretKey:123456

签名后

Sign: 5d34b7fac1a6817ff8466c09000bf886e0a0c348

【错误用法】

1. 先解析到结构体再做签名校验，会导致新增的参数被忽略，验签失败。

2. 解析json数据的时候，对key做了排序，导致收到的json数据和发送的json数据里面的参数顺序不一致，导致验签失败。

3. json数据中，可能会包含空数据(null，{})类型，如果下游接口不理解空数据，可能会过滤掉这个参数，导致验签失败。

Basic Authentication

• 将用户填写用户名和密码通过Request Header传递过去来做鉴权。您的服务器接收到请求后，从

Request Header中获得username与password，如果获得的值与您在Webook通达中配置的一样，则可以确定是此请求是从GMP中发送

Oauth2

Oauth2使用的是客户端账号密码模式

//post form 格式
{
    "client_id":"ClientId",
    "client_secret":"Secret",
    "grant_type":"client_credentials" //写死的
}

//resp 返回内容
{
    "access_token":"123456",
    "token_type":"bearer"
}

最终webhook发送时，token格式是"{token_type} {access_token}" // bearer 123456
在header中填入
Authorization:token //Authorization:bearer 123456

HTTP 200且有Response Body

{
   "message": "success",
   "code":    0,
   "err_data":[
        {
            "logid":"xxx",
            "message":"xxx",
        },
        {
            "logid":"xxx",
            "message":"xxx",
        }
    ]
}