wx.qy.shareToExternalChat

wx.qy.shareToExternalChat(Object object)

该接口支持在小程序环境中,具有客户联系权限的企业成员将文本内容和附件传递到客户群群发、发送到客户群。
为了防止滥用,同一个成员每日向一个客户群最多可群发一条消息,每次群发最多可选200个最近活跃的客户群。

调用说明:
文本最多支持传入4000个字
附件最多支持传入9个,类型支持图片(“image”),视频(“video”),图文(“link”)和小程序(“miniprogram”)
支持传入文本和多附件的能力,仅在企业微信3.1.6及以后版本支持(mac端暂不支持)(查看旧版本接口调用方式)。微信客户端和微信开发者工具都不支持该接口。
必须先调用过wx.qy.login,且session_key未过期,开发者可调用checkSession 检查当前登录态
当前成员必须在应用的可见范围
配置了客户联系功能的用户可调用
应用需有客户联系功能权限(第三方应用需具有“企业客户权限->客户基础信息”权限),否则会报“no permission”错误

参数

Object object
参数名 类型 必填 说明
text Object 文本消息
text::content string 消息文本内容
attachments Array 附件,最多支持添加9个附件
msgtype string 附件类型,可选image、link、miniprogram或者video
image Object 图片消息附件
image::mediaid string 图片的素材id,可通过素材管理接口获得
image::imgUrl string 图片的链接,仅可使用上传图片接口得到的链接,跟图片mediaid填其中一个即可
link Object 图文消息附件
link::title string 图文消息标题,最多64个字节
link::desc string 图文消息摘要,最多512个字节
link::url string 图文消息
link::imgUrl string 图文消息封面图片URL
miniprogram Object 小程序消息附件
miniprogram::appid string 当前小程序appid,必须是关联到企业的小程序应用
miniprogram::title string 小程序消息标题,最多64个字节
miniprogram::imgUrl string 小程序消息封面的URL
miniprogram::page string 小程序打开后的路径,注意要以.html作为后缀,否则在微信端打开会提示找不到页面
video Object 视频消息附件
video::mediaid string 视频的素材id,可通过素材管理接口获得
success Function 群发成功的回调函数
fail Function 群发失败的回调函数
complete Function 调用结束的回调函数(群发成功、失败都会执行)
  • text和attachments不能同时为空(注:若text和attachments同时为空,接口使用老的方式wx.qy.shareToExternalChat方式传参也可以兼容。)
  • attachments中每个附件信息必须与msgtype一致,例如,msgtype指定为image,则需要填写image::imgUrl或者image::mediaid,否则会报错。mediaid和imgUrl只需填写一个,两者同时填写时使用media_id且imgUrl失效,二者不可同时为空

示例代码:

wx.qy.shareToExternalChat({
      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 : "",    //小程序消息的封面图。
                        page: "",        //小程序消息打开后的路径,注意要以.html作为后缀,否则在微信端打开会提示找不到页面
                  },
            },
            {
                  msgtype: "video",    // 消息类型,必填
                  video:{
                        mediaid:"",        // 视频的素材id
                 },
            },
      }],
      success: function(res) {
             //todo:
        }
});
© 1998 - 2021 Tencent Inc. All Rights Reserved