View Categories

Webhooks

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

主题 #

当主题对应的事件被触发时，来鼓会向 Webhook URL 发送请求，你可前往APIs查看请求的完整数据结构。

主题名称业务数据触发事件
创建对话 conversation.createdConversation创建对话
结束对话 conversation.closedConversation手动或自动结束对话
更新对话 conversation.updatedConversation客服修改对话小结
首次分配客服 conversation.scheduledConversation首次分配客服
创建顾客 client.createdClient创建顾客、访客转化为顾客
更新顾客 client.updatedClient在工作台更新顾客参数
删除顾客 client.deletedClient删除顾客
更新访客Client创建访客、更新访客参数

来鼓提供的主题

请求 #

请求中，来鼓会在 HTTP Header 中增加 Meiqia-Signature，企业需要校验该签名，以验证数据安全性，以下是签名校验的具体流程：

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

请求示例 #

POST /api/laigu/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-Signature: 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": ""
    }
}

响应 #

状态码描述
200成功，来鼓将订阅的主题成功推送到 Webhook URL

状态码

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

这篇文章能帮助到你吗？