企业内部开发 客户端API JS-SDK 基础接口 获取进入H5页面的入口环境
获取进入H5页面的入口环境
最后更新:2022/05/06
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
获取进入H5页面的入口环境
最后更新:2022/05/06

调用该接口可以判断用户是从哪个入口打开页面,从而决定是否可以调用客户联系相关的接口

wx.invoke('getContext', {
        }, function(res){
        if(res.err_msg == "getContext:ok"){
            entry  = res.entry ; //返回进入H5页面的入口类型,目前有normal、contact_profile、single_chat_tools、group_chat_tools、chat_attachment
			shareTicket = res.shareTicket; //可用于调用getShareInfo接口
        }else {
            //错误处理
        }
    });

返回参数说明

参数类型说明
entryString场景值
shareTicketString仅当转发时设置了withShareTicket转发到会话的消息进入才返回该字段,详见私密消息

 

返回结果 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

 

1. 此接口仅在企业微信3.0.24及以后版本支持,微信端不支持(微信开发者工具也不支持)。
2. 必须先成功调用agentConfig,否则调用时会报“no permission”错误。
3. 从企业微信3.1.6版本开始,所有应用皆可调用,包括自建应用与第三方应用。

 

附:entry截图说明
1. 联系人详情的入口(注意配置入口是在企业管理端--外部沟通管理--自定义详情页)
配置之后,用户在终端查看外部联系人详情时,入口如下图:

2. 工具栏的入口(单聊或群聊)

3. 聊天附件栏的入口

特别注意:成员自定义对外信息的入口进入的,调用getContext返回的是normal(为什么呢?因为这里不涉及客户管理功能,并不能调用客户联系的相关接口),设置入口如下图:

上一篇
wx.agentConfig
下一篇
选人接口