一、接收消息

1.概述

需根据本产品的规范，对添加的 webhook 地址，实现一个 post 请求接口。

Post 请求用于：推送信息到配置的 webhook 地址。

2. 配置参数

url(String)：webhook 的请求地址。

secret(String)：用于使 webhook 验证本产品有效性。

3. 调用 webhook

当接收到新信息时，调用 webhook 进行消息推送。

Post 请求，url 为用户配置的 http(s)://host。

3.1 请求地址及参数

请求地址：http(s)://host?timestamp=TIMESTAMP&signature=SIGNATURE 地址中携带的参数含义与上述一致，webhook 端可根据 signature 判断请求是否来自于SaleSmartly官方。signature 加密规则是以参数名称按字典序排序后，衔接到 secret 后进行MD5加密的值。（如md5(secret&data=123&event=add_user) ）

Header

content-type: “application/json”

Body

参数名	参数类型	参数含义
event	String	推送 webhook 的事件名。add_user-新增客户 update_user-客户信息更新
data	Object	数据体

3.2 data的数据格式

当 event 为 add_user 时

参数名	参数类型	参数含义
chat_user_id *	String	用户id
name *	String	名称
remark_name *	String	备注名
phone *	String	手机号码
email *	String	邮箱
remark *	String	备注
channel *	Int	社媒渠道 1-Messenger 2-聊天插件 3-Email 4-Telegram 5-Instagram 6-Line 7-WhatsApp Api 8-Facebook主页评论 10-Slack 11-企业微信 12-whatsapp 13-instagram评论 15-Telegram App 16-Tiktok App 17-Tiktok评论 18-vkontakte
labels *	String	标签id及标签值 json格式（[{"id":36577,"label_name":"3"}]）
custom_field *	String	自定义字段名称及自定义字段值（注意只会返回进行更新的自定义字段，不返回全部自定义字段） json格式（{"custom_field1":36577,"custom_field2":[36577,36566]}）
ad_referral *	String	广告id信息 json格式（{"ad_id":123,"ad_title":"title"}）
sys_user_id *	Int	接待成员ID
created_time *	Int	创建时间
updated_time *	Int	更新时间

当 msgType 为 update_user 时

参数名	参数类型	参数含义
chat_user_id *	String	用户id
name *	String	名称
remark_name *	String	备注名
phone *	String	手机号码
email *	String	邮箱
remark *	String	备注
channel *	Int	社媒渠道 1-Messenger 2-聊天插件 3-Email 4-Telegram 5-Instagram 6-Line 7-WhatsApp Api 8-Facebook主页评论 10-Slack 11-企业微信 12-whatsapp 13-instagram评论 15-Telegram App 16-Tiktok App 17-Tiktok评论 18-vkontakte 19-zalo 20-tiktok商业号 21-tiktok商业号评论
labels *	String	标签id及标签值 json格式（[{"id":36577,"label_name":"3"}]）
custom_field *	String	自定义字段名称及自定义字段值（注意只会返回进行更新的自定义字段，不返回全部自定义字段） json格式（{"custom_field1":36577,"custom_field2":[36577,36566]}）
ad_referral *	String	广告id信息 json格式（{"ad_id":123,"ad_title":"title"}）
sys_user_id *	Int	接待成员ID
created_time *	Int	创建时间
updated_time *	Int	更新时间

当 msgType 为 device_event 时（目前仅支持Whatsapp APP渠道）

参数名	参数类型	参数含义
id *	int	云设备id
name *	String	设备名称
phone *	String	手机号码
avatar *	String	云设备头像
channel *	Int	社媒渠道 12-whatsapp App15-Telegram App 16-Tiktok App 19-zalo
status *	Int	0-未连接 1-有效 2-失效
created_time *	Int	创建时间
updated_time *	Int	更新时间

3.3 输入示例

示例1

{
    "event": "add_user",
    "data": {
        "chat_user_id": "2213217a81",
        "name": "测试",
        "remark_name": "",
        "phone": "",
        "email": "1@1.cc",
        "channel": 12,
        "remark": "",
        "labels": [
            {
                "id": 36577,
                "label_name": "3"
            }
        ],
        "custom_field":{
            "custom_field_name1": 111,
            "custom_field_name2": [222,333]
        },
        "ad_referral":{
            "ad_id": 111,
            "ad_title": "title"
        },
        "sys_user_id": 1,
        "created_time": 1732689659,
        "updated_time": 1732776394
    }
}

示例2

{
    "event": "update_user",
    "data": {
        "chat_user_id": "2213217a81",
        "name": "测试",
        "remark_name": "",
        "phone": "",
        "email": "1@1.cc",
        "channel": 12,
        "remark": "",
        "labels": [
            {
                "id": 36577,
                "label_name": "3"
            }
        ],
        "custom_field":{
            "custom_field_name1": 111,
            "custom_field_name2": [222,333]
        },
        "ad_referral":{
            "ad_id": 111,
            "ad_title": "title"
        },
        "sys_user_id": 1,
        "created_time": 1732689659,
        "updated_time": 1732776394
    }    
}

示例3

{
    "event": "device_event",
    "data": {
        "id": 123,
        "name": "测试号",
        "phone": "123456",
        "avatar": "https://123.jpg",
        "channel": 12,
        "status": 2,
        "created_time": 1732689659,
        "updated_time": 1732776394
    }    
}

Webhook接受事件接口文档

一、接收消息#

1.概述#

2. 配置参数#

3. 调用 webhook#

3.1 请求地址及参数#

3.2 data的数据格式#

3.3 输入示例#

示例1#

示例2#

示例3#