分享消息到当前会话 - 接口文档 - 企业微信开发者中心

开发者中心

首页

教程

接口

社区

工具

企业内部开发

快速入门服务端API 客户端API 附录更新日志联系我们

企业内部开发客户端API WECOM-JSSDK 客户联系分享消息到当前会话

分享消息到当前会话

最后更新：2023/10/20

ww.sendChatMessage(params)

ww.sendChatMessage(params)

兼容性：企业微信 2.8.10 开始支持

功能描述

从聊天工具栏或附件栏打开的页面中向当前会话发送消息。

ww.sendChatMessage({
  msgtype: 'text',
  text: {
    content: '你好'
  }
})

参数说明

params: Object

可能为以下类型

属性

类型

默认值

必填

说明

最低版本

enterChat

boolean

否

发送完成后进入会话

企业微信 3.1.10

msgtype

"text"

是

消息类型

text

Object

是

	属性	类型	默认值	必填	说明	最低版本
	content	string		是	文本内容

success

Function

否

成功回调

fail

Function

否

失败回调

cancel

Function

否

取消回调

complete

Function

否

完成回调

或

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

enterChat

boolean

否

发送完成后进入会话

企业微信 3.1.10

msgtype

"miniprogram"

是

消息类型

企业微信 iOS、Android、PC 3.1.0

miniprogram Object 是

属性	类型	必填	说明
appid	string	是	小程序的appid
title	string	是	小程序消息的title
imgUrl	string	是	小程序消息的封面图，必须带 http 或 https 协议头
page	string	是	小程序消息打开后的路径，注意要以 `.html` 作为后缀

success

Function

否

成功回调

fail

Function

否

失败回调

cancel

Function

否

取消回调

complete

Function

否

完成回调

或

属性

类型

默认值

必填

说明

最低版本

enterChat

boolean

否

发送完成后进入会话

企业微信 3.1.10

msgtype

"video"

是

消息类型

video

Object

是

属性

类型

默认值

必填

说明

最低版本

mediaid

string

是

视频的素材 ID

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

success

Function

否

成功回调

fail

Function

否

失败回调

cancel

Function

否

取消回调

complete

Function

否

完成回调

或

属性

类型

默认值

必填

说明

最低版本

enterChat

boolean

否

发送完成后进入会话

企业微信 3.1.10

msgtype

"file"

是

消息类型

file

Object

是

属性

类型

默认值

必填

说明

最低版本

mediaid

string

是

文件素材 ID

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

success

Function

否

成功回调

fail

Function

否

失败回调

cancel

Function

否

取消回调

complete

Function

否

完成回调

或

属性

类型

默认值

必填

说明

最低版本

enterChat

boolean

否

发送完成后进入会话

企业微信 3.1.10

msgtype

"news"

是

消息类型

news

Object

是

属性	类型	必填	说明
link	string	是	页面 URL
title	string	是	卡片标题
desc	string	是	卡片摘要
imgUrl	string	是	封面图片URL

success

Function

否

成功回调

fail

Function

否

失败回调

cancel

Function

否

取消回调

complete

Function

否

完成回调

或

属性

类型

默认值

必填

说明

最低版本

enterChat

boolean

否

发送完成后进入会话

企业微信 3.1.10

msgtype

"msgmenu"

是

消息类型

企业微信 iOS、Android 3.1.12，企业微信 PC 3.1.20

msgmenu

Object

是

属性

类型

默认值

必填

说明

最低版本

head_content

string

是

起始文本

list

Object[]

是

菜单项配置列表

可能为以下类型

属性

类型

默认值

必填

说明

最低版本

type

"click"

是

菜单类型

click

Object

是

	属性	类型	默认值	必填	说明	最低版本
	id	string		是	菜单 ID
	content	string		是	菜单显示内容

或

属性

类型

默认值

必填

说明

最低版本

type

"view"

是

菜单类型

view

Object

是

	属性	类型	默认值	必填	说明	最低版本
	url	string		是	点击后跳转的链接
	content	string		是	菜单显示内容

或

属性

类型

默认值

必填

说明

最低版本

type

"miniprogram"

是

菜单类型

miniprogram

Object

是

属性	类型	必填	说明
appid	string	是	小程序的 appid
page	string	是	小程序消息打开后的路径
content	string	是	小程序消息的 title

success

Function

否

成功回调

fail

Function

否

失败回调

cancel

Function

否

取消回调

complete

Function

否

完成回调

或

属性

类型

默认值

必填

说明

最低版本

enterChat

boolean

否

发送完成后进入会话

企业微信 3.1.10

msgtype

"image"

是

消息类型

image

Object

是

	属性	类型	默认值	必填	说明	最低版本
	mediaid	string		否	图片的素材 ID

success

Function

否

成功回调

fail

Function

否

失败回调

cancel

Function

否

取消回调

complete

Function

否

完成回调

返回说明

Promise<Object>

	属性	类型	默认值	必填	说明	最低版本
	errMsg	string		是	通用错误信息
	errCode	number		是	通用错误码

使用限制

仅从特定入口进入页面才可调用

不同的入口对应用及用户有相应的限制

getContext 接口返回的 entry 值	自建应用	第三方应用	用户	支持的最低版本
single_chat_tools	需有客户联系功能权限	需有“企业客户权限->客户基础信息”权限	配置了客户联系功能	2.8.10
group_chat_tools	需有客户联系功能权限	需有“企业客户权限->客户基础信息”权限	配置了客户联系功能	2.8.10
group_chat_tools	所有	需有「家校沟通」使用权限	所有	3.0.36
group_chat_tools	所有	需有「家校沟通」使用权限	所有	4.0.8
chat_attachment	所有	所有	所有	3.1.6（mac端暂不支持）

获取当前客户群的群ID

群发消息给客户

本节内容

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