七鱼开发文档中心
总览服务端 APIWebiOSAndroid鸿蒙Uniapp微信小程序插件三方接入
企微管理

小程序卡片接入

客服工作台 iframe 小程序卡片 postMessage 和企微账号事件接收说明。

发送小程序卡片

对接入客服工作台的小程序可以发送自定义小程序卡片消息。企业可在接入的 iframe 页面中按下面的规则组装数据对象,然后通过 postMessage 发送到七鱼工作台。

基本实现代码如下:

var data = {
  msgtype: 'miniprogrampage',
  appid: 'xxxxxxxxxxx',
  title: 'title',
  name: 'name',
  pagepath: 'pagepath',
  thumburl: 'http://****/888/1.jpg',
};

window.parent.postMessage(data, '*');

卡片消息字段规则如下:

字段类型必须描述
appidString是小程序 appid,必须是企业工作台已关联的小程序
titleString是小程序消息标题
nameString否小程序名称,主要用于客服工作台展示
pagepathString是小程序页面路径
thumburlString否小程序消息卡片封面图片地址,主要展示在客服工作台,请保证和封面 ID 对应同一张图片

事件接收 URL

说明

  • 企微账号事件推送:七鱼向企业接口推送企微账号状态变更事件。
  • 推送时机:某一企微账号状态发生变更时实时推送。
  • 接收地址:企业提供一个 HTTP URL 作为事件接收地址,例如 http://xxxx/receive。请求 Content-Type 为 application/json;charset=utf-8。
  • 接收参数:七鱼会以 POST 方式推送数据,所有数据都在请求体内。
  • 由于数据包在网络传输过程中可能延迟,发生变更事件的时间应以请求体中的 eventTime 字段为准。

请求体说明

推送数据格式如下:

{
  "appName": "自建应用名称",
  "staffName": "xxxxxx",
  "eventTime": "1748437371877",
  "eventType": "1",
  "wxName": "xxxxxx",
  "staffId": "9032356",
  "account": "xxxxxx"
}

字段定义如下:

字段描述
appName自建应用名称
staffName操作扫码绑定的客服姓名
eventTime事件发生时间
eventType事件类型:1 为二维码验证,2 为离线
wxName企业微信名称
staffId操作扫码绑定的客服 ID
account操作扫码绑定的客服账号

这篇文档有帮助吗?

目录