群发消息到客户群 - 文档 - 企业微信开发者中心

第三方应用开发

快速入门服务端API 客户端API 工具与资源运营规范附录更新日志联系我们

第三方应用开发

客户端API

JS-SDK

客户联系

群发消息到客户群

最后更新：2025/04/21

ww.shareToExternalChat(params)

ww.shareToExternalChat(params)

兼容性：企业微信 2.8.7 开始支持

功能描述

具有客户联系权限的企业成员，可通过该接口将文本内容和附件传递到客户群群发、发送到客户群。

// WeCom >= 3.1.6
ww.shareToExternalChat({
  chatIds: ["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.shareToExternalChat({
  title: '', // 消息的标题
  desc: '', // 消息的描述
  link: '', // 消息链接
  imgUrl: '' // 消息封面
})

使用限制

本接口必须使用应用身份进行注册
应用需有客户联系功能权限
当前成员必须配置了客户联系功能

参数说明

params: Object

可能为以下类型

属性	类型	必填	说明	最低版本
link	string	是	页面 URL
title	string	是	卡片标题
desc	string	是	卡片摘要
imgUrl	string	是	封面图片URL
chatIds	string[]	否	客户群ID	企业微信 iOS、Android、PC 4.1.10
success	Function	否	成功回调
fail	Function	否	失败回调
cancel	Function	否	取消回调
complete	Function	否	完成回调

或

属性类型必填说明最低版本

text

Object

否

企业微信 3.1.6

属性

类型

必填

说明

content

string

是

文本内容

使用限制

最多支持 4000 字

attachments

Object[]

否

使用限制

最多传入 9 个

企业微信 3.1.6

可能为以下类型

属性

类型

必填

说明

msgtype

"image"

是

消息类型

image

Object

是

属性

类型

必填

说明

mediaid

string

否

图片的素材 ID

可以通过素材管理接口获得，暂不支持公众平台的 mediaid

imgUrl

string

否

图片的 url，跟图片素材 ID 填其中一个即可

或

属性

类型

必填

说明

msgtype

"link"

是

消息类型

link

Object

是

属性	类型	必填	说明
title	string	否	H5消息标题
imgUrl	string	否	H5消息封面图片URL
desc	string	否	H5消息摘要
url	string	是	H5消息页面url

或

属性类型必填说明最低版本

msgtype

"miniprogram"

是

消息类型

企业微信 iOS、Android、PC 3.1.0，企业微信 Mac 4.1.26

miniprogram Object 是

属性	类型	必填	说明
appid	string	是	小程序的appid，需要在管理端绑定该小程序
title	string	是	小程序消息的title
imgUrl	string	是	小程序消息的封面图，必须带 http 或 https 协议头
page	string	是	小程序消息打开后的路径，注意要以 `.html` 作为后缀

或

属性

类型

必填

说明

msgtype

"video"

是

消息类型

video

Object

是

属性

类型

必填

说明

mediaid

string

是

视频的素材 ID

可以通过素材管理接口获得，暂不支持公众平台的 mediaid

或

属性

类型

必填

说明

msgtype

"file"

是

消息类型

file

Object

是

属性

类型

必填

说明

mediaid

string

是

文件素材 ID

可以通过素材管理接口获得，暂不支持公众平台的 mediaid

chatIds

string[]

否

客户群ID

企业微信 iOS、Android、PC 4.1.10

success

Function

否

成功回调

fail

Function

否

失败回调

cancel

Function

否

取消回调

complete

Function

否

完成回调

返回说明

Promise<Object>

	属性	类型	必填	说明
	errMsg	string	是	通用错误信息
	errCode	number	是	通用错误码

使用说明

为防止滥用，同一个成员每日向一个客户最多可群发一条消息，每次群发最多可选 2000 个最近活跃的客户群

旧版jweixin调用

示例代码

wx.invoke("shareToExternalChat", {
      chatIds: ["wr2GCAAAXAAAaWJHDDGasdadAAA","wr2GCAAAXBBBaWJHDDGasdadBBB"]; //客户群ID，从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 == "shareToExternalChat:ok") {
        }
	}
);