登录
企业内部开发 客户端API JS-SDK 微信客服 客服工具栏接口
客服工具栏接口
最后更新：2023/07/14
目录
概述
企业可将应用页面配置到客服工具栏，方便接待人员在与微信用户的客服聊天中查看和使用，提高服务效率。从客服工具栏打开的页面，除了一般的jsapi之外，可以使用有会话属性的jsapi，例如：获取当前客户userid、分享消息到当前会话。当然，开发者首先需要调用getContext接口获取当前入口entry值，以此判断是否从客服工具栏进入页面。
接口说明
getContext
接口使用说明详见“获取进入H5页面的入口环境”，在客服工具栏里返回的entry值是single_kf_tools，具体如下：
返回结果 entry 说明
| 值 | 说明 | 支持的最低版本 |
|---|---|---|
| contact_profile | 从联系人详情进入 | 3.0.24 |
| single_chat_tools | 从单聊会话的工具栏进入 | 3.0.24 |
| group_chat_tools | 从群聊会话的工具栏进入 | 3.0.24 |
| chat_attachment | 从会话的聊天附件栏进入 | 3.1.6 |
| single_kf_tools | 从微信客服的工具栏进入 | 3.1.10 |
| normal | 除以上场景之外进入，例如工作台，聊天会话等 | 3.0.24 |
获取当前客户userid
接口使用说明详见“获取当前客户userid”，在客服工具栏里调用该接口，自建应用与第三方应用所需的权限有所不同，具体如下：
| 入口 | [getContext](#getContext)的entry值 | 自建应用 | 第三方应用 | 用户 | 支持的最低版本 |
|---|---|---|---|---|---|
| 微信客服工具栏 | single_kf_tools | 所有 | 需有“微信客服权限->获取基础信息”权限 | 所有 | 3.1.10 |
分享消息到当前会话
接口使用说明详见“分享消息到当前会话”，在客服工具栏里调用该接口，自建应用与第三方应用所需的权限有所不同，具体如下：
| 入口 | [getContext](#getContext)的entry值 | 自建应用 | 第三方应用 | 用户 | 支持的最低版本 |
|---|---|---|---|---|---|
| 微信客服工具栏 | single_kf_tools | 所有 | 需有“微信客服权限->获取基础信息”权限 | 所有 | 3.1.10 |
微信客服工具栏额外支持msgmenu和channels_shop_product的消息类型，具体如下：
msgmenu移动端ios/android从 3.1.12 版本开始支持；桌面端win从 3.1.20 版本开始支持，mac暂不支持channels_shop_product从 4.1.6 版本开始支持，四端均支持，参数可通过获取商品接口和获取店铺基本信息接口获取
需要从客服工具栏进入页面才可调用，否则会报错：unsupported msgtype，可先通过调用getContext来判断进入小程序的入口。
wx.invoke('sendChatMessage', {
msgtype: "msgmenu", //消息类型，必填
enterChat: true, //为true时表示发送完成之后顺便进入会话，默认为false，仅移动端3.1.10及以上版本支持该字段
msgmenu: {
head_content: "您对本次服务是否满意呢? ", // 起始文本
list: [{ // 菜单项配置列表
type: "click", // type 为 click 的菜单项
click: {
id: "101", // 菜单ID
content: "满意", // 菜单显示内容
},
},
{
type: "click",
click: {
id: "102",
content: "不满意",
},
},
{
type: "view", // type 为 view 的菜单项
view: {
url: "https://work.weixin.qq.com", // 点击后跳转的链接
content: "点击跳转到自助查询页面", // 菜单显示内容
},
},
{
type: "miniprogram", // type 为 miniprogram 的菜单项
miniprogram: {
appid: "wx123123123123123", //小程序的appid
page: "pages/index?userid=zhangsan&orderid=123123123", //小程序消息打开后的路径
content: "点击打开小程序查询更多", // 小程序消息的title
},
}],
tail_content: "欢迎再次光临", // 结束文本
},
channelsShopProduct: {
productId: "10000000000000", // 商品ID
shopAppId: "wx123123123123123", // 小店ID
imgUrl: "https://mmecimage.cn/p/xxxxxx"// 商品图像
title: "aaaaa" // 商品名
sellingPrice: "800" // 价格区间最小值(单位分) (销售价)
shopImgUrl: "http://mmbiz.qpic.cn/mmbiz_jpg/xxxx" // 视频号店铺头像URL
shopNickname: "名称" // 视频号店铺名称
},
}, function(res) {
if (res.err_msg == 'sendChatMessage:ok') {
//发送成功
}
})