Webhooks

美洽通过 Webhooks 功能将工作台的对话、顾客、工单数据,以回调方式主动同步到你的服务器,你可以基于收到的数据做进一步处理。

Webhooks 是新在线客服产品线企业版、旗舰版功能。

主题

名字业务对象触发事件
结束对话(conversation.closed)Conversation客服手动结束对话、系统自动结束对话
更新对话(conversation.updated)Conversation客服在【历史】中修改对话的对话小结
创建顾客(client.created)Client访客转换为顾客
更新顾客(client.updated)Client顾客名片(默认字段、自定义字段)被更新
删除顾客(client.deleted)Client客户在【顾客】删除顾客

通知

通知的请求中,美洽会在 HTTP Header 中增加 Meiqia-Signature,企业需要校验该签名,以验证数据安全性,以下是签名校验的具体流程:

  1. 读取 HTTP 请求的 Body,将其转换为字符串 body_str
  2. body_strsecret 拼接成需要加密的字符串 encrypted_strbody_str 在前, secret 在后;
  3. encrypted_str 进行 SHA1 加密得到 signature_str
  4. sign_str 和 HTTP Header 中的 Meiqia-Signature的值进行比对。

接口详情

协议:HTTP

请求方式:POST

Content-Type:application/json;charset = utf-8

Meiqia-Signature: 44cb7f1e544d8830ab0e1feb959b94b3e02eb7e9

Accept-Encoding::gzip

参数样例

POST /api/meiqia/notify HTTP/1.1
Host: 127.0.0.1:5005
User-Agent: Go-http-client/1.1
Content-Length: 3140
Content-Type: application/json; charset=utf-8
Meiqia-Sign: 44cb7f1e544d8830ab0e1feb959b94b3e02eb7e9
Accept-Encoding: gzip

{
    "id": "sub_09e4bee581ffbcd347fcf634e0f99df8_1632648830",   //美洽定义的通知唯一标识
    "event": "conversation.updated",                           //主题
    "enterprise_token": "09e4bee581ffbcd347fcf634e0f99df8",    //美洽定义的企业 Token   
    "created_at": 1632648830,                                  //通知的创建时间
    "conversation": {                                          //主题的业务对象,具体结构会在下文说明
        "enterprise_id": 97631,
        "dev_client_id": null,
        "page_from_url": "",
        "search_engine": ""
    }
}

业务对象

Conversation Object

"conversation": {
    "enterprise_id":97631,                                     //美洽定义的企业唯一标识
    "dev_client_id":null,                                      //第三方定义的并传递给美洽的顾客唯一标识
    "page_from_url":"https://meiqia.com/help",                 //来源页 URL
    "page_land_url":"https://meiqia.com/help",                 //落地页 URL
    "page_land_title":"美洽帮助中心",                            //落地页标题
    "page_conv_url":"https://meiqia.com/help",                 //对话页 URL
    "page_conv_title":"美洽帮助中心",                            //对话页标题
    "search_engine_name":"",                                   //搜索引擎名字
    "search_engine_kw":"",                                     //搜索关键词
    "visitor_ip":"10.51.1.80",                                 //访客(顾客)的 IP
    "visitor_location":"四川成都",                              //根据 IP 解析得到的访客(顾客)地理位置
    "visitor_os":"Mac OS X",                                   //访客(顾客)的操作系统
    "visitor_browser":"Chrome",                                //访客(顾客)的浏览器
    "client_info":{
        "track_id":"1zX5DwiXl9MKmpbFe69AquejdZN"               //美洽定义的顾客唯一标识
    }
    "agent_account":"support@meiqia.com",                      //当前处理客服的邮箱账号
    "agent_name":"support",                                    //当前处理客服的姓名
    "agent_ID":"",                                             //美洽定义的客服唯一标识
    "agent_nick_name":"",                                      //美洽定义的客服唯一标识
    "group_id":3631,                                           //客服所在分组的 ID
    "group_name":"默认分组",                                    //客服所在分组的名字
    "conv_id":3091050268,                                      //美洽随机生成的对话唯一标识
    "conv_start_tm":"2021-09-26 17:33:19.932730",              //对话的创建时间
    "conv_end_tm":"2021-09-26 17:33:50.932730",                //对话的结束时间
    "conv_first_resp_wait_in_secs":23,                         //首次响应时长
    "conv_content": [                                          //对话的消息列表
     {
	"from": "client",
        "timestamp": "2021-11-08 16:13:50.958949",
        "content": "\ufffd\ufffd\ufffd\ufffd\ufffd\ufffd",
        "type": "message"
       }
    ],
    "conv_agent_msg_count":2,                                  //客服发送消息数
    "conv_visitor_msg_count":2,                                //顾客发送消息数
    "conv_quality_grade":"thrid_level",                        //对话的评级
    "conv_leads":"",                                           //对话的线索
    "conv_level":null,                                         //对话的等级
    "comment_content":null,                                    //客服在【质检】填写的质检评语
    "platform":"pc",                                           //顾客发起对话的平台,例如 PC、Mobile
    "conv_tags":null,                                          //对话的标签
    "summary_content":"",                                      //对话小结
    "summary_update_at":"",                                    //对话小结的最后更新时间
    "source_type":"直接访问",                                   //访问的类型
    "source_field":"",                                         //访问的来源
    "agent_resp_duration":"2.608371s",                         //对话的首次响应时长
    "effective":"有效",                                         //对话是有效对话还是无效对话
    "missed":"未遗漏",                                          //对话是否为遗漏对话
    "converse_duration":"25s",                                 //对话的持续时长
    "app_name":"",
    "main_channel":"web",                                      //对话的渠道
    "sub_channel":""                                           //对话的子渠道
}

Client Object

"client": {
    "track_id": "1zX5DwiXl9MKmpbFe69AquejdZN",                //美洽定义的顾客唯一标识
    "created_on": "2021-10-15T07:26:38.36",                   //顾客的创建时间
    "updated_on": "2021-10-27T07:44:28.61",                   //顾客的最后更新时间
    "name": "美洽在线客服",                                     //顾客的姓名
    "age": "11",                                              //顾客的年龄
    "gender": "",                                             //顾客的性别
    "address": "",                                            //顾客的地址
    "tel": "",                                                //顾客的电话
    "weixin": "",                                             //顾客的微信
    "qq": "",                                                 //顾客的QQ
    "email": "",                                              //顾客的邮箱
    "weibo": "美洽",                                           //顾客的微博
    "contact": "",                                            //顾客的联系人
    "comment": "",                                            //客服对顾客的备注
    "__follow_source": "",                                    //微信的关注来源
    "__openid": "",                                           //微信定义的 openid
    "latest_conv_on": "2021-10-15T08:46:06.08",               //顾客最后一次对话的创建时间
    "tag": "",                                                //顾客的标签
    "tags": null,
    "url": "",
    "os_family": "Windows",                                   //最后一次访问的操作系统
    "browser_family": "Firefox",                              //最后一次访问的浏览器
    "ip": "125.69.43.175",                                    //最后一次访问的IP
    "country": "中国",                                         //最后一次访问的国家
    "province": "四川",                                        //最后一次访问的省份
    "city": "成都",                                            //最后一次访问的城市
    "utm_campaign": "",
    "utm_content": "",
    "utm_medium": "",
    "utm_source": "",
    "utm_term": "",
    "landing_page_title": "【官网】美洽客服",                    //最后一次访问的落地页标题
    "landing_page_url": "http://meiqia.com",                  //最后一次访问的落地页网址
    "source_domain": "",                                      //最后一次访问的来源域名
    "source_keyword": "",                                     //最后一次访问的来源关键词
    "source_source": "",
    "source_type": "direct",                                  //最后一次访问的访问来源
    "source_url": ""                                          //最后一次访问的来源页
    "test_first": "自定义字段"                                  //客服在【设置-顾客管理】新增的顾客自定义字段
    "test_second": "自定义字段"                                 //客服在【设置-顾客管理】新增的顾客自定义字段
    }
}

响应

状态码描述
200成功,美洽将订阅的主题成功推送到 Webhook URL

如果没有返回状态码,那么美洽认为本次推送通知失败,暂无重试机制。

常见问题

美洽 Webhooks 推送的服务器地址是什么?
127.0.0.1
最后更新于 2021年11月26日

此内容是否有用?

相关内容