第三方应用开发 客户端API JS-SDK 会话 聊天附件栏接口
聊天附件栏接口

目录

  • 概述
  • 接口说明
  •       getContext
  •       隐藏聊天附件栏的发送按钮
  •       分享消息到当前会话
  • 概述

    企业和用户可将应用页面配置到聊天附件栏,方便成员快捷发送到聊天,提高沟通效率。企业微信会在打开的页面底部固定显示“发送”按钮,开发者也可以调用接口隐藏掉“发送”按钮,然后在页面适当的地方调用“分享消息到当前会话”接口以完成快捷发送。当然,开发者首先需要调用getContext接口获取当前入口entry值,以此判断是否从聊天附件栏进入页面。

    接口说明

    getContext

    接口使用说明详见“获取进入H5页面的入口环境”,在聊天附件栏里返回的entry值是chat_attachment,具体如下:

    返回结果 entry 说明

    说明支持的最低版本
    contact_profile从联系人详情进入3.0.24
    single_chat_tools从单聊会话的工具栏进入3.0.24
    group_chat_tools从群聊会话的工具栏进入3.0.24
    chat_attachment从会话的聊天附件栏进入3.1.6
    normal除以上场景之外进入,例如工作台,聊天会话等3.0.24

     

    隐藏聊天附件栏的发送按钮

    调用该接口可隐藏从聊天附件栏打开页面时固定显示的发送按钮,开发者通过分享消息到当前会话接口灵活适配对页面或页面中具体内容的转发

    wx.invoke('hideChatAttachmentMenu', {
    		 menuList: ["sendMessage"] // 要隐藏的菜单项,sendMessage。即附件栏底部发送按钮。
            }, function(res){
            if(res.err_msg == "hideChatAttachmentMenu:ok"){
            }else {
                //错误处理
    			/*
    			若menuList不包含sendMessage,则报错:"invalid menuList"
    			*/
            }
        });
    1. 此接口仅在企业微信3.1.6及以后版本支持,微信端不支持(微信开发者工具也不支持)。
    2. 必须先成功调用agentConfig,否则调用时会报“no permission”错误
    3. 需要从附件栏进入才允许调用,否则会报错:without context of chat_attachment,可先通过调用getContext接口来判断进入页面的入口。

     

    分享消息到当前会话

    在聊天附件栏里,所有应用都可以调用该接口,接口使用说明详见“分享消息到当前会话”。

     

    上一篇
    变更群成员
    下一篇
    分享消息到当前会话