登录
基础
连接微信
办公基础连接微信办公兼容性：企业微信 2.8.10 开始支持
从聊天工具栏或附件栏打开的页面中向当前会话发送消息。
ww.sendChatMessage({
msgtype: 'text',
text: {
content: '你好'
}
})可能为以下类型
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| enterChat | boolean | 否 | 发送完成后进入会话 | 企业微信 3.1.10 | ||||||||||||||||
| msgtype | "text" | 是 | 消息类型 | |||||||||||||||||
| text | Object | 是 | ||||||||||||||||||
| ||||||||||||||||||||
| success | Function | 否 | 成功回调 | |||||||||||||||||
| fail | Function | 否 | 失败回调 | |||||||||||||||||
| cancel | Function | 否 | 取消回调 | |||||||||||||||||
| complete | Function | 否 | 完成回调 | |||||||||||||||||
或
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| enterChat | boolean | 否 | 发送完成后进入会话 | 企业微信 3.1.10 | |||||||||||||||||||||||||||||||||||||
| msgtype | "miniprogram" | 是 | 消息类型 | 企业微信 iOS、Android、PC 3.1.0 | |||||||||||||||||||||||||||||||||||||
| miniprogram | Object | 是 | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| success | Function | 否 | 成功回调 | ||||||||||||||||||||||||||||||||||||||
| fail | Function | 否 | 失败回调 | ||||||||||||||||||||||||||||||||||||||
| cancel | Function | 否 | 取消回调 | ||||||||||||||||||||||||||||||||||||||
| complete | Function | 否 | 完成回调 | ||||||||||||||||||||||||||||||||||||||
或
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| enterChat | boolean | 否 | 发送完成后进入会话 | 企业微信 3.1.10 | ||||||||||||||||
| msgtype | "video" | 是 | 消息类型 | |||||||||||||||||
| video | Object | 是 | ||||||||||||||||||
| ||||||||||||||||||||
| success | Function | 否 | 成功回调 | |||||||||||||||||
| fail | Function | 否 | 失败回调 | |||||||||||||||||
| cancel | Function | 否 | 取消回调 | |||||||||||||||||
| complete | Function | 否 | 完成回调 | |||||||||||||||||
或
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| enterChat | boolean | 否 | 发送完成后进入会话 | 企业微信 3.1.10 | ||||||||||||||||
| msgtype | "file" | 是 | 消息类型 | |||||||||||||||||
| file | Object | 是 | ||||||||||||||||||
| ||||||||||||||||||||
| success | Function | 否 | 成功回调 | |||||||||||||||||
| fail | Function | 否 | 失败回调 | |||||||||||||||||
| cancel | Function | 否 | 取消回调 | |||||||||||||||||
| complete | Function | 否 | 完成回调 | |||||||||||||||||
或
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | ||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| enterChat | boolean | 否 | 发送完成后进入会话 | 企业微信 3.1.10 | |||||||||||||||||||||||||||||||||||||
| msgtype | "news" | 是 | 消息类型 | ||||||||||||||||||||||||||||||||||||||
| news | Object | 是 | |||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||
| success | Function | 否 | 成功回调 | ||||||||||||||||||||||||||||||||||||||
| fail | Function | 否 | 失败回调 | ||||||||||||||||||||||||||||||||||||||
| cancel | Function | 否 | 取消回调 | ||||||||||||||||||||||||||||||||||||||
| complete | Function | 否 | 完成回调 | ||||||||||||||||||||||||||||||||||||||
或
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| enterChat | boolean | 否 | 发送完成后进入会话 | 企业微信 3.1.10 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| msgtype | "msgmenu" | 是 | 消息类型 | 企业微信 iOS、Android 3.1.12，企业微信 PC 3.1.20 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| msgmenu | Object | 是 | ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| ||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| success | Function | 否 | 成功回调 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| fail | Function | 否 | 失败回调 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| cancel | Function | 否 | 取消回调 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| complete | Function | 否 | 完成回调 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
或
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| enterChat | boolean | 否 | 发送完成后进入会话 | 企业微信 3.1.10 | ||||||||||||||||
| msgtype | "image" | 是 | 消息类型 | |||||||||||||||||
| image | Object | 是 | ||||||||||||||||||
| ||||||||||||||||||||
| success | Function | 否 | 成功回调 | |||||||||||||||||
| fail | Function | 否 | 失败回调 | |||||||||||||||||
| cancel | Function | 否 | 取消回调 | |||||||||||||||||
| complete | Function | 否 | 完成回调 | |||||||||||||||||
Promise<Object>
| 属性 | 类型 | 默认值 | 必填 | 说明 | 最低版本 | |
|---|---|---|---|---|---|---|
| errMsg | string | 是 | 通用错误信息 | |||
| errCode | number | 是 | 通用错误码 |
仅从特定入口进入页面才可调用
不同的入口对应用及用户有相应的限制
| getContext 接口返回的 entry 值 | 自建应用 | 第三方应用 | 用户 | 支持的最低版本 |
|---|---|---|---|---|
| single_chat_tools | 需有客户联系功能权限 | 需有“企业客户权限->客户基础信息”权限 | 配置了客户联系功能 | 2.8.10 |
| group_chat_tools | 需有客户联系功能权限 | 需有“企业客户权限->客户基础信息”权限 | 配置了客户联系功能 | 2.8.10 |
| group_chat_tools | 所有 | 需有「家校沟通」使用权限 | 所有 | 3.0.36 |
| group_chat_tools | 所有 | 需有「家校沟通」使用权限 | 所有 | 4.0.8 |
| chat_attachment | 所有 | 所有 | 所有 | 3.1.6（mac端暂不支持） |
基础连接微信办公基础连接微信办公基础连接微信办公