企业自建应用开发
小程序
基础
连接微信
办公
JS-SDK
基础
连接微信
办公
消息推送(原“群机器人”)
企业自建应用开发
客户端API
JS-SDK
客户联系
群发消息到客户群
群发消息到客户群
最后更新:2025/04/21

目录

  • ww.shareToExternalChat(params)
  • 功能描述
  • 使用限制
  • 参数说明
  • params: Object
  • 返回说明
  • 旧版jweixin调用
  • 示例代码
  • 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

    可能为以下类型

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

    页面 URL

    titlestring是

    卡片标题

    descstring是

    卡片摘要

    imgUrlstring是

    封面图片URL

    chatIdsstring[]否

    客户群ID

    企业微信 iOS、Android、PC 4.1.10

    successFunction否

    成功回调

    failFunction否

    失败回调

    cancelFunction否

    取消回调

    completeFunction否

    完成回调

    或

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

    企业微信 3.1.6

    属性类型必填说明
    contentstring是

    文本内容

    使用限制

    最多支持 4000 字

    attachmentsObject[]否

    使用限制

    最多传入 9 个

    企业微信 3.1.6

    可能为以下类型

    属性类型必填说明
    msgtype"image"是

    消息类型

    imageObject是
    属性类型必填说明
    mediaidstring否

    图片的素材 ID

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

    imgUrlstring否

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

    或

    属性类型必填说明
    msgtype"link"是

    消息类型

    linkObject是
    属性类型必填说明
    titlestring否

    H5消息标题

    imgUrlstring否

    H5消息封面图片URL

    descstring否

    H5消息摘要

    urlstring是

    H5消息页面url

    或

    属性类型必填说明最低版本
    msgtype"miniprogram"是

    消息类型

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

    miniprogramObject是
    属性类型必填说明
    appidstring是

    小程序的appid,需要在管理端绑定该小程序

    titlestring是

    小程序消息的title

    imgUrlstring是

    小程序消息的封面图,必须带 http 或 https 协议头

    pagestring是

    小程序消息打开后的路径,注意要以 .html 作为后缀

    或

    属性类型必填说明
    msgtype"video"是

    消息类型

    videoObject是
    属性类型必填说明
    mediaidstring是

    视频的素材 ID

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

    或

    属性类型必填说明
    msgtype"file"是

    消息类型

    fileObject是
    属性类型必填说明
    mediaidstring是

    文件素材 ID

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

    chatIdsstring[]否

    客户群ID

    企业微信 iOS、Android、PC 4.1.10

    successFunction否

    成功回调

    failFunction否

    失败回调

    cancelFunction否

    取消回调

    completeFunction否

    完成回调

    返回说明

    Promise<Object>

    属性类型必填说明
    errMsgstring是

    通用错误信息

    errCodenumber是

    通用错误码

    使用说明

    • 为防止滥用,同一个成员每日向一个客户最多可群发一条消息,每次群发最多可选 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") {
            }
    	}
    );
    上一篇群发消息给客户
    下一篇进入添加客户界面
      本节内容
    服务端API
    基础
    连接微信
    办公
    文档
    接收外部数据到智能表格
    会议
    会议统计管理
    客户端API
    小程序
    基础
    连接微信
    办公
    JS-SDK
    基础
    连接微信
    办公
    消息推送(原“群机器人”)
    更新日志