目录
兼容性:企业微信 2.8.7 开始支持
具有客户联系权限的企业成员,可通过该接口将文本内容和附件传递到群发助手、发送给客户。
// WeCom >= 3.1.6
ww.shareToExternalContact({
externalUserIds: ["wr2GCAAAXAAAaWJHDDGasdadAAA","wr2GCAAAXBBBaWJHDDGasdadBBB"],
text: {
content: '企业微信'
},
attachments: [
{
msgtype: 'image',
image: {
imgUrl: 'https://res.mail.qq.com/node/ww/wwmng/style/images/index_share_logo$13c64306.png'
}
}
]
})
// 或者
ww.shareToExternalContact({
title: '', // 消息的标题
desc: '', // 消息的描述
link: '', // 消息链接
imgUrl: '' // 消息封面
})
params: Object
可能为以下类型
| 属性 | 类型 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|
| link | string | 是 | 页面 URL | |
| title | string | 是 | 卡片标题 | |
| desc | string | 是 | 卡片摘要 | |
| imgUrl | string | 是 | 封面图片URL | |
| success | Function | 否 | 成功回调 | |
| fail | Function | 否 | 失败回调 | |
| cancel | Function | 否 | 取消回调 | |
| complete | Function | 否 | 完成回调 |
或
| 属性 | 类型 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|
| text | Object | 否 | 企业微信 3.1.6 | |
| attachments | Object[] | 否 | 使用限制 最多传入 9 个 | 企业微信 3.1.6 |
| externalUserIds | string[] | 否 | 客户列表 | 企业微信 iOS、Android、PC 4.1.10 |
| success | Function | 否 | 成功回调 | |
| fail | Function | 否 | 失败回调 | |
| cancel | Function | 否 | 取消回调 | |
| complete | Function | 否 | 完成回调 |
text 子字段:
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| content | string | 是 | 文本内容 使用限制:最多支持 4000 字 |
attachments 子字段(可能为以下类型):
image 类型
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| msgtype | "image" | 是 | 消息类型 |
| image | Object | 是 |
image 子字段:
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mediaid | string | 否 | 图片的素材 ID 可以通过素材管理接口获得,暂不支持公众平台的 mediaid |
| imgUrl | string | 否 | 图片的 url,跟图片素材 ID 填其中一个即可 |
或 link 类型
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| msgtype | "link" | 是 | 消息类型 |
| link | Object | 是 |
link 子字段:
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| title | string | 否 | H5消息标题 |
| imgUrl | string | 否 | H5消息封面图片URL |
| desc | string | 否 | H5消息摘要 |
| url | string | 是 | H5消息页面url |
或 miniprogram 类型
| 属性 | 类型 | 必填 | 说明 | 最低版本 |
|---|---|---|---|---|
| msgtype | "miniprogram" | 是 | 消息类型 | 企业微信 iOS、Android、PC 3.1.0,企业微信 Mac 4.1.26 |
| miniprogram | Object | 是 |
miniprogram 子字段:
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| appid | string | 是 | 小程序的appid,需要在管理端绑定该小程序 |
| title | string | 是 | 小程序消息的title |
| imgUrl | string | 是 | 小程序消息的封面图,必须带 http 或 https 协议头 |
| page | string | 是 | 小程序消息打开后的路径,注意要以 .html 作为后缀 |
或 video 类型
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| msgtype | "video" | 是 | 消息类型 |
| video | Object | 是 |
video 子字段:
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mediaid | string | 是 | 视频的素材 ID 可以通过素材管理接口获得,暂不支持公众平台的 mediaid |
或 file 类型
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| msgtype | "file" | 是 | 消息类型 |
| file | Object | 是 |
file 子字段:
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| mediaid | string | 是 | 文件素材 ID 可以通过素材管理接口获得,暂不支持公众平台的 mediaid |
Promise<Object>
| 属性 | 类型 | 必填 | 说明 |
|---|---|---|---|
| errMsg | string | 是 | 通用错误信息 |
| errCode | number | 是 | 通用错误码 |
wx.invoke("shareToExternalContact", {
externalUserIds: ["wmEAlECwAAHrbAAAOK5u3Bf13xlYDAAA","wmEAlECwAAHiBBBDOK5u3Af13xlYDBBB"],//客户列表,从4.1.10版本开始支持(mac端不支持)
text: {
content:"", // 文本内容
},
attachments: [
{
msgtype: "image", // 消息类型,必填
image: {
mediaid: "", // 图片的素材id
imgUrl: "", // 图片的imgUrl,跟图片mediaid填其中一个即可
},
},
{
msgtype: "link", // 消息类型,必填
link: {
title: "", // H5消息标题
imgUrl: "", // H5消息封面图片URL
desc: "", // H5消息摘要
url: "", // H5消息页面url 必填
},
},
{
msgtype: "miniprogram", // 消息类型,必填
miniprogram: {
appid: "", // 小程序的appid
title: "", // 小程序消息的title
imgUrl : "", //小程序消息的封面图。必须带http或者https协议头
page: "", //小程序消息打开后的路径,注意要以.html作为后缀,否则在微信端打开会提示找不到页面
},
},
{
msgtype: "video", // 消息类型,必填
video:{
mediaid:"", // 视频的素材id
},
},
{
msgtype: "file", // 消息类型,必填,从3.1.12版本开始支持
file:{
mediaid:"", // 文件的素材id,必填
},
},
]},function(res) {
if (res.err_msg == "shareToExternalContact:ok") {
}
}
);
