企业内部开发 客户端API JS-SDK 客户联系 群发消息给客户
群发消息给客户
最后更新:2023/09/25
可联系渠道经理采购或代理智慧硬件接口已支持设备 联系渠道经理
群发消息给客户
最后更新:2023/09/25

具有客户联系权限的企业成员,可通过该接口将文本内容和附件传递到群发助手、发送给客户。当前暂仅支持在企业微信内调用。
为了防止滥用,同一个成员每日向一个客户最多可群发一条消息,每次群发最多可选20000个客户。

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") {
        }
	}
);
* 企业微信3.1.6及以上版本支持text与attachments参数,旧版本不支持(mac端也暂不支持)(查看旧版本接口调用方式)。微信客户端不支持(微信开发者工具也不支持)。
* 文本最多支持传入4000个字
* 附件最多支持传入9个,类型支持图片(“image”),视频(“video”),图文(“link”),小程序(“miniprogram”)和文件(“file”)
* 支持传入文本和多附件的能力,仅在企业微信3.1.6及以后版本支持(mac端暂不支持)。微信客户端和微信开发者工具都不支持
* 必须先成功调用agentConfig,否则调用时会报“no permission”错误
* 当前成员必须配置了客户联系功能
* agentConfig中所填agentid对应应用,需有配置客户联系功能权限
* text和attachments不能同时为空(注:若text和attachments同时为空,接口使用老的方式shareToExternalContact传参也可以兼容。)
* attachments中每个附件信息必须与msgtype一致,例如,msgtype指定为image,则需要填写image::imgUrl或者image::mediaid,否则会报错。mediaid和imgUrl只需填写一个,两者同时填写时使用media_id且imgUrl失效,二者不可同时为空
* 图片或者视频的mediaid,可通过素材管理接口获得
上一篇
分享消息到当前会话
下一篇
群发消息到客户群