调用该接口可以判断用户是从哪个入口打开页面,从而决定是否可以调用客户联系相关的接口
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 {
//错误处理
}
});
返回参数说明
参数 | 类型 | 说明 |
---|---|---|
entry | String | 场景值 |
shareTicket | String | 仅当转发时设置了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(为什么呢?因为这里不涉及客户管理功能,并不能调用客户联系的相关接口),设置入口如下图: