第三方应用开发 客户端API 小程序 微信客服 客服工具栏接口
客服工具栏接口

目录

  • 概述
  • 接口说明
  •       getContext
  •       获取当前客户userid
  •       分享消息到当前会话
  • 概述

    企业可将应用页面配置到客服工具栏,方便接待人员在与微信用户的客服聊天中查看和使用,提高服务效率。从客服工具栏打开的页面,除了一般的小程序接口之外,可以使用有会话属性的接口,例如:获取当前客户userid、分享消息到当前会话。当然,开发者首先需要调用getContext接口获取当前入口entry值,以此判断是否从客服工具栏进入页面。

    接口说明

    getContext

    接口使用说明详见“wx.qy.getContext”,在客服工具栏里返回的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

    接口使用说明详见“wx.qy.getCurExternalContact”,在客服工具栏里调用该接口,自建应用与第三方应用所需的权限有所不同,具体如下:

    入口[getContext](#getContext)的entry值自建应用第三方应用用户支持的最低版本
    微信客服工具栏single_kf_tools所有需有“微信客服权限->获取基础信息”权限所有3.1.10

    分享消息到当前会话

    接口使用说明详见“wx.qy.sendChatMessage”,在客服工具栏里调用该接口,自建应用与第三方应用所需的权限有所不同,具体如下:

    入口[getContext](#getContext)的entry值自建应用第三方应用用户支持的最低版本
    微信客服工具栏single_kf_tools所有需有“微信客服权限->获取基础信息”权限所有3.1.10

    微信客服工具栏额外支持msgmenu的消息类型,具体如下:

    移动端ios/android从 3.1.12 版本开始支持;桌面端win从 3.1.20 版本开始支持,mac暂不支持
    需要从客服工具栏进入页面才可调用,否则会报错:unsupported msgtype,可先通过调用“wx.qy.getContext”来判断进入小程序的入口。

    参数说明

    参数名类型必填说明
    msgtypestring消息类型
    enterChatBoolean为true时表示发送完成之后顺便进入会话,默认为false,仅移动端3.1.10及以上版本支持该字段
    msgmenuObject菜单消息
    msgmenu::head_contentstring起始文本
    不多于1024字节
    msgmenu::listObject菜单项配置列表
    msgmenu::list::typestring菜单类型。
    click-回复菜单 view-超链接菜单 miniprogram-小程序菜单
    msgmenu::list::clickObjecttype为click的菜单项
    msgmenu::list::click::idstring菜单ID
    不少于1字节
    不多于64字节
    msgmenu::list::click::contentstring菜单显示内容
    不少于1字节
    不多于128字节
    msgmenu::list::viewObjecttype为view的菜单项
    msgmenu::list::view::urlstring点击后跳转的链接
    不少于1字节
    不多于2048字节
    msgmenu::list::view::contentstring菜单显示内容
    不少于1字节
    不多于1024字节
    msgmenu::list.miniprogramObjecttype为miniprogram的菜单项
    msgmenu::list.miniprogram::appidstring小程序appid,必须是当前聊天工具栏打开的小程序
    不少于1字节
    不多于32字节
    msgmenu::list.miniprogram::pagestring小程序打开后的路径,注意要以.html作为后缀,否则在微信端打开会提示找不到页面
    不少于1字节
    不多于1024字节
    msgmenu::list.miniprogram::contentstring菜单显示内容
    不少于1字节
    不多于1024字节
    msgmenu::tail_contentstring结束文本
    不多于1024字节
    successFunction群发成功的回调函数
    failFunction群发失败的回调函数
    completeFunction调用结束的回调函数(群发成功、失败都会执行)

    示例代码

    wx.qy.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: "欢迎再次光临", // 结束文本
        },
    	success: function(res) {
             //todo:
        }
    });
    上一篇
    wx.qy.updateMomentsSetting
    下一篇
    微信小程序打开微信客服