第三方应用开发 客户端API JS-SDK 上下游 聊天工具栏接口
聊天工具栏接口

目录

  • 概述
  • 接口说明
  •       getContext
  •       获取当前上下游联系人userid
  •       获取当前上下游互联群的群ID
  •       分享消息到当前会话
  • 概述

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

    接口说明

    getContext

    接口使用说明详见“获取进入H5页面的入口环境”,在上下游聊天工具栏里返回的entry值是chain_single_chat_tools或chain_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
    chain_single_chat_tools从上下游单聊会话的工具栏进入4.0.8
    chain_group_chat_tools从上下游群聊会话的工具栏进入4.0.8
    normal除以上场景之外进入,例如工作台,聊天会话等3.0.24

    获取当前上下游联系人userid

    wx.invoke('getCurCorpGroupContact', {
            }, function(res){
            if(res.err_msg == "getCurCorpGroupContact:ok"){
                corpId = res.corpId; // 返回当前联系人的企业corpId
                userId  = res.userId ; //返回当前联系人userId
            }else {
                //错误处理
            }
        });
    必须先成功调用agentConfig,否则调用时会报“no permission”错误
    当前成员必须在应用的可见范围
    需要从上下游会话的工具栏进入页面才可调用,否则会报错:without context of corpgroup contact,可先通过调用getContext来判断进入页面的入口。
    入口getContext的entry值自建应用第三方应用用户支持的最低版本
    上下游单聊会话的工具栏chain_single_chat_tools所有所有所有4.0.8

    获取当前上下游互联群的群ID

    wx.invoke('getCurCorpGroupChat', {
            }, function(res){
            if(res.err_msg == "getCurCorpGroupContact:ok"){
                chatId = res.chatId; // 返回当前互联群的群ID
            }else {
                //错误处理
            }
        });
    必须先成功调用agentConfig,否则调用时会报“no permission”错误
    当前成员必须在应用的可见范围
    需要从上下游会话的工具栏进入页面才可调用,否则会报错:without context of corpgroup contact,可先通过调用getContext来判断进入页面的入口。
    入口getContext的entry值自建应用第三方应用用户支持的最低版本
    上下游群聊会话的工具栏chain_group_chat_tools所有所有所有4.0.12

     

    分享消息到当前会话

    接口使用说明详见“分享消息到当前会话”,可在上下游的聊天工具栏里可调用该接口,调用前可先通过调用wx.qy.getContext来判断进入小程序的入口。

    入口getContext自建应用第三方应用用户支持的最低版本
    上下游单聊会话的工具栏chain_single_chat_tools所有所有所有4.0.8
    上下游群聊会话的工具栏chain_group_chat_tools所有所有所有4.0.8
    上一篇
    微盘和文档选择器
    下一篇
    发起班级收款