wx.qy.sendChatMessage

wx.qy.sendChatMessage(Object object)

通过聊天工具栏或者附件栏向当前会话发送消息,支持多种消息格式,包括文本(“text”),图片(“image”),视频(“video”),文件(“file”)、H5(“news”)和小程序(“miniprogram”)。

调用前提:

  1. 此接口仅在企业微信3.0.16及以后版本支持聊天工具栏,仅在3.1.6及以后版本支持聊天附件栏
  2. 必须先调用过wx.qy.login,且session_key未过期,开发者可调用checkSession 检查当前登录态
  3. 当前成员必须在应用的可见范围,否则报错:user not in allow list
  4. 配置了客户联系功能的用户可调用,否则报错:no permission
  5. 聊天工具栏中调用,应用需有客户联系功能权限(第三方应用需具有“企业客户权限->客户基础信息”权限),否则会报“no permission”错误。若在内部群聊天附件栏进入,则当前用户需在应用可见范围,否则会报“no permission”错误
  6. 从聊天附件栏调用该接口时,当前成员不需要具备客户服务权限,当前应用不需要拥有客户联系权限
  7. 需要从客户会话或客户群的聊天工具栏或者所有会话的聊天附件栏进入页面时才可成功调用该接口,否则会报错:without context of external contact,可先通过调用wx.qy.getContext来判断进入小程序的入口(仅entry为single_chat_tools、group_chat_tools或者chat_attachment时可调用)
  8. 在企业微信3.0.36及以后版本,支持应用在家校班级群的聊天工具栏调用(注:第三方应用需拥有「家校沟通」使用权限)
  9. mac暂不支持在聊天附件栏中调用

参数

Object object
参数名 类型 必填 说明
msgtype string 消息类型
text Object 文本消息
text::content string 文本消息内容
image Object 图片消息
image::mediaid string 图片的素材id,可通过素材管理接口获得
video Object 视频消息
video::mediaid string 视频的素材id,可通过素材管理接口获得
file Object 文件消息
file::mediaid string 文件的素材id,可通过素材管理接口获得
news Object H5消息
news::link string H5消息页面url
news::title string H5消息标题
news::desc string H5消息摘要
news::imgUrl string H5消息封面图片URL
miniprogram Object 小程序消息
miniprogram::appid string 小程序appid,必须是当前聊天工具栏打开的小程序
miniprogram::title string 小程序消息标题
miniprogram::imgUrl string 消息显示图片的链接,可以是网络图片路径或本地图片文件路径或相对代码包根目录的图片文件路径。显示图片长宽比是 5:4。
若使用网络图片路径,必须带http或者https协议头,否则报错 $apiName$:fail invalid imgUrl
miniprogram::page string 小程序打开后的路径,注意要以.html作为后缀,否则在微信端打开会提示找不到页面
success Function 群发成功的回调函数
fail Function 群发失败的回调函数
complete Function 调用结束的回调函数(群发成功、失败都会执行)

示例代码:

wx.qy.sendChatMessage({
    msgtype:"text", //消息类型,必填
    text: {
        content:"你好", //文本内容
    },
    image:
    {
        mediaid: "", //图片的素材id
    },
    video:
    {
        mediaid: "", //视频的素材id
    },
    file:
    {
       mediaid: "", //文件的素材id
    },
    news:
    {
        link: "", //H5消息页面url 必填
        title: "", //H5消息标题
        desc: "", //H5消息摘要
        imgUrl: "", //H5消息封面图片URL
    },
    miniprogram:
    {
        appid: "wx8bd80126147df384",//小程序的appid
        title: "this is title", //小程序消息的title
        imgUrl:"/appData/pic/pic1.jpg",//小程序消息的封面图
        page:"/index/page.html", //小程序消息打开后的路径,注意要以.html作为后缀,否则在微信端打开会提示找不到页面
    },
    success: function(res) {
         //todo:
    }
});
© 1998 - 2021 Tencent Inc. All Rights Reserved