salesmartly_webhook
    salesmartly_webhook
    • Webhook接受消息接口文档
    • Webhook接受事件接口文档
    • 主动发送信息接口文档

    主动发送信息接口文档

    一、发送消息#

    1.概述#

    需根据本产品的规范，对添加的 Salesmartly 接口地址，实现一个 post 请求接口。
    Post 请求用于：推送信息到配置的 Salesmartly 接口地址。

    2. 配置参数#

    url(String)：Salesmartly 接口地址。
    signature(String)：用于使 Salesmartly 接口验证本信息有效性。
    data(Json)：需要推送的消息

    3. 调用 Salesmartly 接口地址#

    当需要发送新信息时，调用 Salesmartly 接口地址进行消息推送。
    Post 请求，Whatsapp Api 接口地址：
    https://webhook.salesmartly.com/whatsapp/send
    Post 请求，Messenger 接口地址：
    https://webhook.salesmartly.com/messenger/send
    Post 请求，Line 接口地址：
    https://webhook.salesmartly.com/line/send
    Post 请求，Whatsapp App 接口地址：
    https://webhook.salesmartly.com/individual_whatsapp/send
    Post 请求，Instagram 接口地址：
    https://webhook.salesmartly.com/instagram/send
    Post 请求，Plugin 接口地址：
    https://webhook.salesmartly.com/plugin/send
    Post 请求，Telegram App 接口地址：
    https://webhook.salesmartly.com/telegram_app/send

    3.1 请求地址及参数#

    请求地址：http(s)://host?timestamp=TIMESTAMP&signature=webhook_token 地址中携带的参数含义与上述一致。
    Header
    content-type: “application/json”
    Body
    参数名参数类型参数含义
    dataJson新消息的数据体

    3.2 data的数据格式#

    消息格式
    参数名参数类型参数含义
    msg_type *String默认为3
    msg *Object消息内容
    chat_user_id *String用户id
    chat_session_id *String会话id
    send_time *String消息发送时间
    tagStringMessenger消息标签（只支持Messenger渠道，具体参考示例1） 可传：CONFIRMED_EVENT_UPDATE-确认事件更新 POST_PURCHASE_UPDATE-售后更新 ACCOUNT_UPDATE-账户更新

    3.3 输入示例#

    示例1 回复文本消息#
    {
    "data":{
        "msg_type":3,
        "msg":{
            "template1":{
                "text":"\u60a8\u9009\u62e9\u5546\u54c1\u662f\u624b\u5957\uff0c\u94fe\u63a5\uff1ahttps://ss.com"
            },
            "template2":{
                "text":"\u60a8\u9009\u62e9\u5546\u54c1\u662f\u624b\u5957\uff0c\u94fe\u63a5\uff1ahttps://ss.com"
            },
            // 最多支持五个template
        },
        "chat_user_id":"6537425481afde78d31e7651",
        "chat_session_id":"130925",
        "send_time":"1695799154645",
        "channel":1，
        "tag":"CONFIRMED_EVENT_UPDATE"
    }
}
    示例2 回复文本按钮消息(Whatsapp App,Telegram App,Plugin和Instagram渠道不支持)#
    {
    "data":{
        "msg_type":3,
        "msg":{
            "template1":{
                "title":"\u6930\u5b50\u997c\u5e72ok\u561b1",
                "buttons": {
                    "button1":{
                        "id":"ACT:1",
                        "text" : "choose"
                    }
                }
            },
            "template2":{
                "title":"\u6930\u5b50\u997c\u5e72ok\u561b2",
                "buttons": {
                    "button1":{
                        "id":"ACT:2",
                        "text" : "choose"
                    }
                }
            },
            // 最多支持五个template
        },
        "chat_user_id":"65094291e106072b7e40ff21",
        "chat_session_id":"130925",
        "send_time":"1695799154645",
        "channel":2
    }
}
    示例3 回复图片+文本按钮消息(Whatsapp App,Telegram App, Plugin和Instagram渠道不支持)#
    {
    "data":{
        "msg_type":3,
        "msg":{
            "template1":{
            	"image":"https://ss.com",
                "title":"\u6930\u5b50\u997c\u5e72ok\u561b1",
                "buttons": {
                    "button1":{
                        "id":"ACT:1",
                        "text" : "choose"
                    }
                }
            },
            "template2":{
            	"image":"https://ss.com",
                "title":"\u6930\u5b50\u997c\u5e72ok\u561b2",
                "buttons": {
                    "button1":{
                        "id":"ACT:2",
                        "text" : "choose"
                    }
                }
            },
            // 最多支持五个template
        },
        "chat_user_id":"65094291e106072b7e40ff21",
        "chat_session_id":"130925",
        "send_time":"1695799154645",
        "channel":2
    }
}
    示例4 回复图片+文本消息#
    {
    "data":{
        "msg_type":3,
        "msg":{
            "template1":{
                "image":"https://ss.com",
                "text":"\u60a8\u9009\u62e9\u5546\u54c1\u662f\u624b\u5957\uff0c\u94fe\u63a5\uff1ahttps://ss.com"
            },
            "template2":{
                "image":"https://ss.com",
                "text":"\u60a8\u9009\u62e9\u5546\u54c1\u662f\u624b\u5957\uff0c\u94fe\u63a5\uff1ahttps://ss.com"
            },
            // 最多支持五个template
        },
        "chat_user_id":"65094291e106072b7e40ff21",
        "chat_session_id":"130925",
        "send_time":"1695799154645",
        "channel":7
    }
}
    示例5 回复商品轮播消息（仅支持Messenger和line渠道）#
    {
    "data":{
        "msg_type":27,
        "msg":{
            "template":{
                "generic":[
                  {
                    "title":"Welcome!",
                    "image_url":"https://petersfancybrownhats.com/company_image.png",
                    "subtitle":"We have the right hat for everyone.",
                    "buttons":[
                      {
                          "id":"ACT:1",
                          "text":"Start Chatting"
                      } // 最多支持三个button              
                    ]      
                  } // 最多不超过十个generic
                ]
            }
        },
        "chat_user_id":"65094291e106072b7e40ff21",
        "chat_session_id":"130925",
        "send_time":"1695799154645",
        "channel":2
    }
}
    示例6 回复文件消息（仅支持Whatsapp Api,Telegram App，Whatsapp App, Plugin和Messenger）#
    {
    "data":{
        "msg_type":3,
        "msg":{
            "template1":{
                "file":"https://www.com/company_image.txt"
            },
            "template2":{
                "file":"https://www.com/company_image.txt"
            },
            // 最多支持五个template
        },
        "chat_user_id":"6537425481afde78d31e7651",
        "chat_session_id":"130925",
        "send_time":"1695799154645",
        "channel":1，
        "tag":"CONFIRMED_EVENT_UPDATE"
    }
}

    4. 返回#

    正常返回
    {
    "code":0,
    "msg":"具体消息"
}
    异常返回
    {
    "code":-1,
    "msg":"错误原因"
}
    content-type：”application/json”
    修改于 2025-05-09 02:58:03
    上一页
    Webhook接受事件接口文档
    Built with