企业配置接收地址后客服可以在工单中回复顾客至webhook渠道,企业接收处理后可以将回复推送至与顾客连接的任意渠道。
请求
请求中,美洽会在 HTTP Header 中增加 Meiqia-Signature
,企业需要校验该签名,以验证数据安全性,以下是签名校验的具体流程:
- 读取 HTTP 请求的 Body,将其转换为json字符串
body_str
; - 将
body_str
和secret
拼接成需要加密的字符串encrypted_str
,body_str
在前,secret
在后; - 对
encrypted_str
进行 SHA1 加密得到signature_str
; - 将
signature_str
和 HTTP Header 中的Meiqia-Signature
的值进行比对。
请求示例
POST /ticket/webhook/test HTTP/1.1
Host: 127.0.0.1:8080
User-Agent: Go-http-client/1.1
Content-Length: 2592
Content-Type: application/json;charset=utf-8
Meiqia-Sign: 47f0f3115406da60cbe6f8e7271c8e65c9e078dd
Accept-Encoding: gzip
{
"event" : "new_ticket.comment",
"businessId": 517, //工单编号
"content": "<p style=\"text-align:center;\">回复富文本</p>", //回复内容(富文本)
"contentBy": "管理员", //回复人名称
"contentAt": "2023-04-24 18:00:18", //回复时间
"ticket": [ //工单详情
{
"fieldName": "title", //工单字段名称
"fieldValue": "test", //工单字段值
"display": true //是否显示
},
{
"fieldName": "stateStage",
"fieldValue": "PROCESSING",
"display": false
}
],
"customer": {
"__follow_source": "", //顾客来源
"__openid": "", //顾客微信openId
"address": "",
"age": 0,
"comment": "",
"contact": "",
"email": "",
"enterprise_id": 1, //顾客所属企业id
"gender": "",
"name": "",
"qq": "",
"tel": "",
"test": "",
"track_id": "", //顾客唯一标识
"weibo": "",
"weixin": "",
${自定义字段name}:${value} //自定义字段
}
}
重试机制
当前设置推送消息异常时,最大重试 2 次,初始重试等待时长 5000 ms,下次等待时长为上次的 2 倍递增
响应
状态码 | 描述 | 备注 |
200 | 成功,美洽将订阅的主题成功推送到 Webhook URL | 返回参数含 code=200,美洽工单进行成功后的记录 |
更多关于webhook对接的内容可以参考:https://meiqia.com/help/article/webhooks/