第三方应用开发
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
第三方应用开发
客户端API
小程序
客户联系
「联系我」插件
「联系我」插件
最后更新:2021/08/09

企业微信客户服务插件

 

为了方便客户直接联系企业成员进行沟通,企业可以将一个或多个成员配置到「联系我」二维码或者「联系我」按钮,并将二维码直接展示给客户或将按钮配置到小程序中。客户扫描二维码或在小程序中点击按钮后即可获得成员的企业微信联系方式,客户添加后即可直接加成员为好友并发起沟通。

企业管理员可在“企业微信管理后台->客户联系->加客户->联系我”中完成「联系我」二维码和「联系我」按钮两种联系方式的创建和配置,从而建立企业成员与客户的连接。其中「联系我」按钮需要开发者做简单的开发配置,开发者可按以下文档说明完成配置「联系我」按钮到小程序的接入工作。

微信iOS系统V8.0.6和安卓系统V8.0.3及以上版本的用户可直接在小程序内长按识别「联系我」二维码了,之前版本的用户仍需通过接收服务通知获取联系方式。

一、小程序插件接入步骤

  1. 开发者在小程序管理后台申请使用插件,添加路径:设置 ->第三方服务 -> 插件管理 -> 添加插件,搜索并添加插件ID: wx104a1a20c3f81ec2,无需审核确认。
  2. 开发者在小程序app.json 文件中添加对插件的引用
    "plugins": {
    	"contactPlugin": {
    		"version": "1.4.3",
    		"provider": "wx104a1a20c3f81ec2"
    	}
    }  

  3. 开发者在具体引用插件的页面文件json文件中,添加对组件的引用,例如:
    "usingComponents": {
    	"cell": "plugin://contactPlugin/cell"
    }

  4. 开发者在引用插件的wxml文件中添加组件的具体代码,其中plugid为在企业微信管理后台配置的客服ID,将该ID作为参数传入组件,例如:
    <cell bind:startmessage='startmessage' bind:completemessage="completemessage" plugid='plugid'  />

参数说明:

属性类型默认值必填说明
startmessagefunction监听按钮点击事件执行开始时的回调
completemessagefunction监听按钮点击事件执行完毕后的回调
plugidstring在企业微信管理后台配置的唯一客服ID

其中 completemessage 回调接收的参数格式如下:

{
    errcode: 0,  // 消息发送状态
    name: '',  // 推送的客服人员姓名
    headurl: ''  // 推送的客服人员头像
	notifytype: 0,  // 0: 表示消息通知的方式  1:表示二维码的方式
}

请开发者注意,name和headurl参数在 errcode 为0和-3006 时才会返回,errcode 的异常错误码说明如下:
-3002:获取插件配置信息失败
-3004:用户信息授权失败
-3005:客服消息发送失败
-3006:发送的客服人员已经和当前用户是好友关系,如果 notifytype = 1,则为二维码展示方式,此时仍会展示二维码
-3008:当前配置没有客服人员

二、插件扩展参数说明

为了对插件的UI表现进行定制,插件提供了以下参数对插件的UI进行进一步的扩展配置,可配置的公用属性如下:

属性类型默认值必填说明
styleTypenumber插件ID后台的样式配置通过此属性可强制覆盖在企业微信管理后台配置的主样式类型,枚举值:1(插件整行显示的样式)2(插件只显示为一个按钮的样式) 3(显示为聊天气泡的样式)
avatorStylestringcircle单人客服且styleType为1时有效,控制头像的展示类型,枚举值:rect、circle
isMasknumber0单人客服且styleType为1时有效,控制是否展示客服真实姓名 ,可选项:0、1
contactTextnumber0单人客服styleType为1且isMask为1时有效、styleType为3时有效、多人客服styleType为1时有效,不支持自定义显示文案,可选项:'咨询服务'、'在线咨询'、'联系客服',分别对应的值为 0、1、2
buttonTextnumber0单人客服以及多人客服出现按钮时有效,不支持自定义按钮文案,可选项:'联系我', '立即联系', '咨询服务', '在线咨询', '联系客服',分别的值为 0~4
buttonStylestringprimary单人客服以及多人客服出现按钮时有效,用于控制按钮的显示样式,可选项:primary(深蓝色背景)、light(白底背景)
serviceTextnumber0单人客服以及styleType为3时有效,不支持自定义按钮文案,可选项:'有什么问题可以联系我咨询', '联系服务人员咨询', '获取服务人员联系方式', '联系客服咨询更多问题',分别的值为 0~3
paddingStylenumber0单人客服以及多人客服styleType为1时有效,用于控制控件的内填充样式,可自定义填充数值
iconStylestringavator多人客服styleType为1时有效,用于控制图标显示为深蓝色图标还是白底图标,可选项:avator(头像图标)、primary(深蓝色图标)、light(白底图标)
blockStylestringbubble单人客服以及多人客服styleType为2时有效,用于控制显示一个圆形按钮还是一个文字按钮,枚举值:bubble(圆形按钮)、button(文字按钮)
bubbleColorstring4790EE单人客服以及多人客服styleType为2时有效,用于控制圆形按钮的背景色,可自定义传入的色值的16进制值,不用带#号

三、插件运行环境说明

小程序版本的插件目前仅支持运行在微信的小程序环境中,企业微信环境暂不支持。

 

上一篇wx.qy.navigateToAddCustomer
下一篇wx.qy.shareToExternalMoments
    本节内容
服务端API
基础
数据与智能专区
应用接收专区通知
连接微信
客户联系
办公
小程序接入对外收款
客户端API
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
更新日志
联系我们