登录
基础
连接微信
办公基础连接微信办公目录
兼容性：企业微信 2.8.10 开始支持
从聊天工具栏或附件栏打开的页面中向当前会话发送消息
ww.sendChatMessage({
msgtype: 'text',
text: {
content: '你好'
}
})本接口必须使用应用身份进行注册
仅从特定入口进入页面才可调用，可通过 getContext 接口进行判断
不同的入口对应用及用户有相应的限制
| 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 端暂不支持） | |
| single_kf_tools | 所有 | 需有“微信客服权限->获取基础信息”权限 | 所有 | 企业微信 3.1.10 |
消息中的 mediaId 可通过素材管理接口获得，暂不支持公众平台的 mediaId
可能为以下类型
| 属性 | 类型 | 必填 | 说明 | 最低版本 | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| 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，企业微信 Mac 4.1.26 | ||||||||||||||||||||||||||
| 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 | "channels_shop_product" | 是 | 消息类型 使用限制 仅支持从客服工具栏进入的页面调用, 即 | 企业微信 4.1.6 | |||||||||||||||||||||||||||||||||||||||||
| channelsShopProduct | 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 | 是 | 通用错误码 |
消息格式支持文本(“text”)，图片(“image”)，视频(“video”)，文件(“file”)，H5(“news”），小程序(“miniprogram”)，菜单消息（“msgmenu”）和视频号商品（“channels_shop_product”）
| errMsg | 说明 |
|---|---|
| sendChatMessage:ok | 执行成功 |
| claimClassAdmin:fail without context of external contact | 当前页面打开的场景不支持调用 |
| claimClassAdmin:fail no permission | 应用签名错误，或不满足权限要求 |
| claimClassAdmin:fail invalid imgUrl | 小程序消息封面图不合法 |
wx.invoke('sendChatMessage', {
msgtype:"text", //消息类型，必填
enterChat: true, //为true时表示发送完成之后顺便进入会话，仅移动端3.1.10及以上版本支持该字段
text: {
content:"你好", //文本内容
},
image:
{
mediaid: "", //图片的素材id
},
video:
{
mediaid: "", //视频的素材id
},
file:
{
mediaid: "", //文件的素材id
},
news:
{
link: "", //H5消息页面url 必填
title: "", //H5消息标题
desc: "", //H5消息摘要
imgUrl: "", //H5消息封面图片URL
},
miniprogram:
{
appid: "wx8bd80126147df384",//小程序的appid，企业已关联的任一个小程序
title: "this is title", //小程序消息的title
imgUrl:"https://search-operate.cdn.bcebos.com/d054b8892a7ab572cb296d62ec7f97b6.png",//小程序消息的封面图。必须带http或者https协议头，否则报错 $apiName$:fail invalid imgUrl
page:"/index/page.html", //小程序消息打开后的路径，注意要以.html作为后缀，否则在微信端打开会提示找不到页面
},
}, function(res) {
if (res.err_msg == 'sendChatMessage:ok') {
//发送成功
}
})
基础连接微信办公基础连接微信办公基础连接微信办公