ww.getContext.md 16 KB
ww.getContext
最后更新：2025/04/09
目录
- ww.getContext([params])
- 功能描述
- 参数说明
- params: Object
- 返回说明
- 使用说明
- Entry入口说明
- 联系人详情的入口
- 工具栏的入口（单聊或群聊）
- 聊天附件栏的入口
- 内部群群看板的入口
- 特别注意
- 旧版jweixin调用
- 示例代码
ww.getContext([params])
兼容性：企业微信 3.0.24 开始支持
功能描述
获取当前页面打开场景。
ww.getContext()
参数说明
params: Object
| 属性 | 类型 | 必填 | 说明 | |
|---|---|---|---|---|
| success | Function | 否 | 成功回调 | |
| fail | Function | 否 | 失败回调 | |
| cancel | Function | 否 | 取消回调 | |
| complete | Function | 否 | 完成回调 |
返回说明
Promise
| 属性 | 类型 | 必填 | 说明 | |
|---|---|---|---|---|
| errMsg | string | 是 | 通用错误信息 | |
| errCode | number | 是 | 通用错误码 | |
| entry | string | 是 | 进入页面的场景类型 | |
| 合法值 |
说明
最低版本
contact_profile
从联系人详情进入
single_chat_tools
从单聊会话的工具栏进入
group_chat_tools
从群聊会话的工具栏进入
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
internal_group_chat_board
从内部群群看板进入
企业微信 4.1.36
normal
除以上场景之外进入，例如工作台，聊天会话等 | 合法值
说明
最低版本
contact_profile
从联系人详情进入
single_chat_tools
从单聊会话的工具栏进入
group_chat_tools
从群聊会话的工具栏进入
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
internal_group_chat_board
从内部群群看板进入
企业微信 4.1.36
normal
除以上场景之外进入，例如工作台，聊天会话等 | 合法值
说明
最低版本
contact_profile
从联系人详情进入
single_chat_tools
从单聊会话的工具栏进入
group_chat_tools
从群聊会话的工具栏进入
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
internal_group_chat_board
从内部群群看板进入
企业微信 4.1.36
normal
除以上场景之外进入，例如工作台，聊天会话等 | 合法值
说明
最低版本
contact_profile
从联系人详情进入
single_chat_tools
从单聊会话的工具栏进入
group_chat_tools
从群聊会话的工具栏进入
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
internal_group_chat_board
从内部群群看板进入
企业微信 4.1.36
normal
除以上场景之外进入，例如工作台，聊天会话等 |
| | shareTicket | string | 否 | 从设置了 withShareTicket: true 的消息进入时返回该字段，用于私密分享 |
使用说明
调用该接口可以判断用户是从哪个入口打开页面，从而决定是否可以调用客户联系相关的接口。
[](https://developer.work.weixin.qq.com/document/path/94315/#entry%E5%85%A5%E5%8F%A3%E8%AF%B4%E6%98%8E)Entry入口说明
[](https://developer.work.weixin.qq.com/document/path/94315/#%E8%81%94%E7%B3%BB%E4%BA%BA%E8%AF%A6%E6%83%85%E7%9A%84%E5%85%A5%E5%8F%A3)联系人详情的入口
注意配置入口是在企业管理端--外部沟通管理--自定义详情页)
配置之后，用户在终端查看外部联系人详情时，入口如下图：
[](https://developer.work.weixin.qq.com/document/path/94315/#%E5%B7%A5%E5%85%B7%E6%A0%8F%E7%9A%84%E5%85%A5%E5%8F%A3%EF%BC%88%E5%8D%95%E8%81%8A%E6%88%96%E7%BE%A4%E8%81%8A%EF%BC%89)工具栏的入口（单聊或群聊）
[](https://developer.work.weixin.qq.com/document/path/94315/#%E8%81%8A%E5%A4%A9%E9%99%84%E4%BB%B6%E6%A0%8F%E7%9A%84%E5%85%A5%E5%8F%A3)聊天附件栏的入口
[](https://developer.work.weixin.qq.com/document/path/94315/#%E5%86%85%E9%83%A8%E7%BE%A4%E7%BE%A4%E7%9C%8B%E6%9D%BF%E7%9A%84%E5%85%A5%E5%8F%A3)内部群群看板的入口
配置入口在内部群的聊天信息-群看板（目前仅桌面端支持配置）：
配置之后，桌面端查看入口：
移动端查看入口：
[](https://developer.work.weixin.qq.com/document/path/94315/#%E7%89%B9%E5%88%AB%E6%B3%A8%E6%84%8F)特别注意
成员自定义对外信息的入口进入的，调用getContext返回的是normal（为什么呢？因为这里不涉及客户管理功能，并不能调用客户联系的相关接口），设置入口如下图：
[](https://developer.work.weixin.qq.com/document/path/94315/#%E6%97%A7%E7%89%88jweixin%E8%B0%83%E7%94%A8)旧版jweixin调用
[](https://developer.work.weixin.qq.com/document/path/94315/#%E7%A4%BA%E4%BE%8B%E4%BB%A3%E7%A0%81)示例代码
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 {
//错误处理
}
});