企业内部开发 客户端API JS-SDK 客户联系 聊天工具栏接口
聊天工具栏接口

目录

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

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

    接口说明

    getContext

    接口使用说明详见“获取进入H5页面的入口环境”,在聊天工具栏里返回的entry值是single_chat_tools或group_chat_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_chat_tools需有客户联系功能权限需有“企业客户权限->客户基础信息”权限配置了客户联系功能2.8.10

    获取当前客户群的群ID

    接口使用说明详见“获取当前客户群的群ID”,在聊天工具栏里调用该接口,自建应用与第三方应用所需的权限有所不同,具体如下:

    入口[getContext](#getContext)的entry值自建应用第三方应用用户支持的最低版本
    外部群聊工具栏group_chat_tools需有客户联系功能权限需有“企业客户权限->客户基础信息”权限配置了客户联系功能2.8.17
    班级群的聊天工具栏group_chat_tools需有客户联系功能权限需有「家校沟通」使用权限所有3.0.36

    分享消息到当前会话

    接口使用说明详见“分享消息到当前会话”,在聊天工具栏里调用该接口,自建应用与第三方应用所需的权限有所不同,具体如下:

    入口[getContext](#getContext)的entry值自建应用第三方应用用户支持的最低版本
    外部单聊工具栏single_chat_tools需有客户联系功能权限需有“企业客户权限->客户基础信息”权限配置了客户联系功能2.8.10
    外部群聊工具栏group_chat_tools需有客户联系功能权限需有“企业客户权限->客户基础信息”权限配置了客户联系功能2.8.10
    班级群的聊天工具栏group_chat_tools需有客户联系功能权限需有「家校沟通」使用权限所有3.0.36
    上一篇
    打开个人信息页接口
    下一篇
    获取当前外部联系人userid