第三方应用开发
小程序
基础
连接微信
办公
WECOM-JSSDK
JS-SDK
基础
连接微信
办公
第三方应用开发
客户端API
WECOM-JSSDK
客户联系
群发消息给客户
群发消息给客户
最后更新:2024/05/13

目录

  • ww.shareToExternalContact(params)
  • 功能描述
  • 参数说明
  • params: Object
  • 返回说明
  • 使用限制
  • ww.shareToExternalContact(params)

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

    功能描述

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

    ww.shareToExternalContact({
      text: {
        content: '企业微信'
      },
      attachments: [
        {
          msgtype: 'image',
          image: {
            imgUrl: 'https://res.mail.qq.com/node/ww/wwmng/style/images/index_share_logo$13c64306.png'
          }
        }
      ]
    })

    参数说明

    params: Object

    可能为以下类型

    属性类型默认值必填说明最低版本
    linkstring

    页面 URL

    titlestring

    卡片标题

    descstring

    卡片摘要

    imgUrlstring

    封面图片URL

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    属性类型默认值必填说明最低版本
    textObject

    企业微信 3.1.6

    属性类型默认值必填说明最低版本
    contentstring

    文本内容

    attachmentsObject[]

    企业微信 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

    miniprogramObject
    属性类型默认值必填说明最低版本
    appidstring

    小程序的appid

    titlestring

    小程序消息的title

    imgUrlstring

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

    pagestring

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

    属性类型默认值必填说明最低版本
    msgtype"video"

    消息类型

    videoObject
    属性类型默认值必填说明最低版本
    mediaidstring

    视频的素材 ID

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

    successFunction

    成功回调

    failFunction

    失败回调

    cancelFunction

    取消回调

    completeFunction

    完成回调

    返回说明

    Promise<Object>

    属性类型默认值必填说明最低版本
    errMsgstring

    通用错误信息

    errCodenumber

    通用错误码

    使用限制

    • 为防止滥用,同一个成员每日向一个客户最多可群发一条消息,每次群发最多可选 20000 个客户

    • 当前成员必须配置了客户联系功能

    • 第三方应用须配置客户联系功能权限

    上一篇分享消息到当前会话
    下一篇群发消息到客户群
      本节内容
    服务端API
    基础
    数据与智能专区
    应用接收专区通知
    连接微信
    客户联系
    办公
    小程序接入对外收款
    客户端API
    小程序
    基础
    连接微信
    办公
    WECOM-JSSDK
    JS-SDK
    基础
    连接微信
    办公
    更新日志
    联系我们