聊天工具栏接口

[TOC]

概述

企业可将应用页面配置到聊天工具栏,方便成员在与客户的聊天中查看和使用,提高服务效率。从聊天工具栏打开的页面,除了一般的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的entry值 自建应用 第三方应用 用户 支持的最低版本
外部单聊工具栏 single_chat_tools 需有客户联系功能权限 需有“企业客户权限->客户基础信息”权限 配置了客户联系功能 2.8.10

获取当前客户群的群ID

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

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

分享消息到当前会话

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

入口 getContext的entry值 自建应用 第三方应用 用户 支持的最低版本
外部单聊工具栏 single_chat_tools 需有客户联系功能权限 需有“企业客户权限->客户基础信息”权限 配置了客户联系功能 2.8.10
外部群聊工具栏 group_chat_tools 需有客户联系功能权限 需有“企业客户权限->客户基础信息”权限 配置了客户联系功能 2.8.10
班级群的聊天工具栏 group_chat_tools 需有客户联系功能权限 需有「家校沟通」使用权限 所有 3.0.36
© 1998 - 2021 Tencent Inc. All Rights Reserved