参数说明

更新于 2024-02-02

执行动作说明

入参	类型	必填	详细说明
msg	Object	是	发送消息的类型。
image	Object	是	图片消息。
media_id	String	是	可以通过调用上传媒体文件接口获取mediaId参数值。
chatid	String	是	输入群会话ID，待发送群的会话ID。

入参	类型	必填	详细说明
msg	Object	否	消息类型。
oa	Object	否	oa消息。
head	Object	否	消息头部内容。
bgcolor	String	否	消息头部的背景颜色。长度限制为8个英文字符，其中前2为表示透明度，后6位表示颜色值。不要添加0x。
text	String	否	消息的头部标题。说明向普通会话发送时有效，向企业会话发送时会被替换为微应用的名字长度限制为最多10个字符。
pc_message_url	String	否	PC端点击消息时跳转到的地址。
body	Object	否	消息体。
file_count	String	否	自定义的附件数目。说明此数字仅供显示，钉钉不作验证。
image	String	否	可以通过调用上传媒体文件接口获取mediaId参数值。
form	Array of Object	否	消息体的表单。例如： Loading... 说明最多显示6个，超过会被隐藏。
key	String	否	消息体的关键字。
value	String	否	消息体的关键字对应的值。
author	String	否	自定义的作者名字。
rich	Object	否	单行富文本信息。
unit	String	否	单行富文本信息的单位。
num	String	否	单行富文本信息的数目。
title	String	否	消息体的标题。说明建议50个字符以内
content	String	否	消息体的内容。说明最多显示3行。
message_url	String	否	消息点击链接地址，当发送消息为小程序时支持小程序跳转链接。
chatid	String	否	输入群会话ID，待发送群的会话ID。

入参	类型	必填	详细说明
msg	Object	否	消息类型。
voice	Object	否	voice消息。
duration	String	否	录音时长，单位s。说明播放长度不超过60s。
media_id	String	否	可以通过调用上传媒体文件接口获取mediaId参数值。说明不超过2MB，AMR格式。
chatid	String	否	输入群会话ID，待发送群的会话ID。

入参	类型	必填	详细说明
msg	Object	是	发送消息的类型。
file	Object	是	文件消息。
media_id	String	是	可以通过调用上传媒体文件接口获取mediaId参数值。
chatid	String	是	输入群会话ID，待发送群的会话ID。

整体跳转ActionCard样式，支持一个点击Action，必须传入参数 single_title和 single_url。

独立跳转ActionCard样式，支持多个点击Action，必须传入参数 btn_orientation 和 btn_json_list。

名称	类型	是否必填	描述
chatid	String	否	输入群会话ID，待发送群的会话ID。
msg	Object	否	发送消息的类型。
action_card	Object	否	卡片消息。
agentid	String	否	应用在企业的AgentId。
btn_json_list	Array	否	使用独立跳转ActionCard样式时的按钮列表。说明必须与btn_orientation同时设置。
action_url	String	否	使用独立跳转消息点击链接地址。
title	String	否	使用独立跳转ActionCard样式时的按钮的标题。说明最长20个字符。
single_url	String	否	使用整体跳转消息点击链接地址。说明最长500个字符。
btn_orientation	String	否	使用独立跳转ActionCard样式时的按钮排列方式： 0：竖直排列 1：横向排列说明必须与btn_json_list同时设置。
single_title	String	否	使用整体跳转ActionCard样式时的标题。说明必须与single_url同时设置。最长20个字符。
markdown	String	否	消息内容。说明建议1000个字符以内。
hide_avatar	Boolean	否	是否隐藏发送者头像。
title	String	否	透出到会话列表和通知的文案。说明最长64个字符。

这篇文档是否有帮助？

本页内容