发送消息内容

本文将说明发送消息、回复消息接口中各类型消息的 content 字段应如何构造。

本文中的示例代码，所有的receive_id, user_id, image_key, file_key等均为示例数据，开发者需要根据实际使用情况进行替换。

本文的内容构造示例仅适用于新版本发送消息接口，请勿使用历史版本发送文本消息接口。

请求体示例

Content 是 string 类型， json 结构需要转义。可以先构造一个结构体，然后使用json序列化后再转成string类型，也可以通过已有的网页json转换工具进行转义。

以文本类型消息为例，请求体示例如下：

{
    "receive_id": "ou_7d8a6e6df7621556ce0d21922b676706ccs",
    "content": "{\"text\":\" test content\"}",
    "msg_type": "text"
}

各类型消息 json 结构

文本 text

{
    "text": "test content"
}

发消息请求体示例

{
    "receive_id": "ou_7d8a6e6df7621556ce0d21922b676706ccs",
    "content": "{\"text\":\" test content\"}",
    "msg_type": "text"
}

换行符使用说明

如果需要文本中进行换行，需要增加转义

{
    "receive_id": "oc_xxx",
    "content": "{\"text\":\"firstline \\n second line  \"}",
    "msg_type": "text"
}

文本消息@用法说明

 // @ 单个用户
<at user_id="ou_xxx">名字</at>
// @ 所有人
<at user_id="all">所有人</at>

示例

{
    "receive_id": "oc_xxx",
    "content": "{\"text\":\"<at user_id=\\\"ou_xxx\\\">Tom</at> text content\"}",
    "msg_type": "text"
}

@单个用户时，user_id字段可填open_id，union_id和user_id，必须是有效值，否则取名字展示，没有@效果。

@所有人必须满足所在群开启@所有人功能。

同一条消息内的ID类型必须保持一致。

消息发送后的效果

富文本 post

富文本可以在一条消息中同时支持文字、At、图片、超链接等元素。

一个富文本可分多个段落（由多个[]组成），每个段落可由多个元素组成，每个元素由tag和相应的字段描述组成。主要图片元素必须是独立的一个段落。

{
	"zh_cn": {
		"title": "我是一个标题",
		"content": [
			[{
					"tag": "text",
					"text": "第一行 :"
				},
				{
					"tag": "a",
					"href": "http://www.feishu.cn",
					"text": "超链接"
				},
				{
					"tag": "at",
					"user_id": "ou_1avnmsbv3k45jnk34j5",
					"user_name": "tom"
				}
			],
			[{
				"tag": "img",
				"image_key": "img_7ea74629-9191-4176-998c-2e603c9c5e8g"
			}],
			[{
					"tag": "text",
					"text": "第二行:"
				},
				{
					"tag": "text",
					"text": "文本测试"
				}
			],
			[{
				"tag": "img",
				"image_key": "img_7ea74629-9191-4176-998c-2e603c9c5e8g"
			}],
          	[{
				"tag": "media",
				"file_key": "file_v2_0dcdd7d9-fib0-4432-a519-41d25aca542j",
				"image_key": "img_7ea74629-9191-4176-998c-2e603c9c5e8g"
			}],
          	[{
				"tag": "emotion",
				"emoji_type": "SMILE"
			}]
		]
	},
	"en_us": {
		...
	}
}

富文本支持的标签和参数说明 :

text

字段	类型	必须	描述	默认值	示例
text	string	是	文本内容	无	test content
un_escape	bool	否	表示是不是 unescape 解码，默认为 false ，不用可以不填	false	false

字段	类型	必须	描述	默认值	示例
text	string	是	文本内容	无	超链接
href	string	是	默认的链接地址	无	http://www.feishu.cn

字段	类型	必须	描述	默认值	实例
user_id	string	是	open_id，union_id或user_id 注意: @单个用户时，user_id字段必须是有效值；@所有人填"all"。	无	ou_18eac85d35a26f989317ad4f02e8bbbb
user_name	string	否	用户姓名	无	tom

img

字段	类型	必须	描述	默认值	实例
image_key	string	是	图片的唯一标识	无	d640eeea-4d2f-4cb3-88d8-c964fab53987

通过上传图片接口获取image_key。

media

字段	类型	必须	描述	默认值	实例
file_key	string	是	视频文件的唯一标识	无	file_v2_0dcdd7d9-fib0-4432-a519-41d25aca542j
image_key	string	否	视频封面图片的唯一标识	无	img_7ea74629-9191-4176-998c-2e603c9c5e8g

通过上传文件接口获取file_key。

emotion

字段	类型	必须	描述	默认值	实例
emoji_type	string	是	表情类型，参见表情文案	无	SMILE

发消息请求体示例

{
	"receive_id": "oc_820faa21d7ed275b53d1727a0feaa917",
	"content": "{\"zh_cn\":{\"title\":\"我是一个标题\",\"content\":[[{\"tag\":\"text\",\"text\":\"第一行 :\"},{\"tag\":\"a\",\"href\":\"http://www.feishu.cn\",\"text\":\"超链接\"},{\"tag\":\"at\",\"user_id\":\"ou_1avnmsbv3k45jnk34j5\",\"user_name\":\"tom\"}],[{\"tag\":\"img\",\"image_key\":\"img_7ea74629-9191-4176-998c-2e603c9c5e8g\"}],[{\"tag\":\"text\",\"text\":\"第二行:\"},{\"tag\":\"text\",\"text\":\"文本测试\"}],[{\"tag\":\"img\",\"image_key\":\"img_7ea74629-9191-4176-998c-2e603c9c5e8g\"}]]}}",
	"msg_type": "post"
}

消息发送后的效果

图片 image

通过上传图片接口获取image_key。

{
    "image_key": "img_7ea74629-9191-4176-998c-2e603c9c5e8g"
}

发消息请求体示例

{
	"receive_id": "oc_xxx",
	"content": "{\"image_key\": \"img_v2_xxx\"}",
	"msg_type": "image"
}

消息发送后的效果

消息卡片 interactive

卡片结构各字段说明请参考卡片模块介绍。
还可以使用消息卡片搭建工具自由搭建你需要的卡片。

注意：

如果你使用的是历史版本的发送消息卡片，请求体中的content参数需要换成card。

新版发送消息接口中，消息请求体的内容参数已统一为content。

消息卡片的 update_multi（是否为共享卡片）字段在卡片内容的config结构体中设置。详细参考文档配置卡片属性

发消息请求体示例

{
    "receive_id": "oc_820faa21d7ed275b53d1727a0feaa917",
    "content": "{\"config\":{\"wide_screen_mode\":true},\"elements\":[{\"alt\":{\"content\":\"\",\"tag\":\"plain_text\"},\"img_key\":\"img_7ea74629-9191-4176-998c-2e603c9c5e8g\",\"tag\":\"img\"},{\"tag\":\"div\",\"text\":{\"content\":\"你是否曾因为一本书而产生心灵共振，开始感悟人生？\\n你有哪些想极力推荐给他人的珍藏书单？\\n\\n加入 **4·23 飞书读书节**，分享你的**挚爱书单**及**读书笔记**，**赢取千元读书礼**！\\n\\n📬 填写问卷，晒出你的珍藏好书\\n😍 想知道其他人都推荐了哪些好书？马上[入群围观](https://open.feishu.cn/)\\n📝 用[读书笔记模板](https://open.feishu.cn/)（桌面端打开），记录你的心得体会\\n🙌 更有惊喜特邀嘉宾 4月12日起带你共读\",\"tag\":\"lark_md\"}},{\"actions\":[{\"tag\":\"button\",\"text\":{\"content\":\"立即推荐好书\",\"tag\":\"plain_text\"},\"type\":\"primary\",\"url\":\"https://open.feishu.cn/\"},{\"tag\":\"button\",\"text\":{\"content\":\"查看活动指南\",\"tag\":\"plain_text\"},\"type\":\"default\",\"url\":\"https://open.feishu.cn/\"}],\"tag\":\"action\"}],\"header\":{\"template\":\"turquoise\",\"title\":{\"content\":\"📚晒挚爱好书，赢读书礼金\",\"tag\":\"plain_text\"}}}",
    "msg_type": "interactive"
}

消息发送后的效果

分享群名片 share_chat

{
    "chat_id": "oc_0dd200d32fda15216d2c2ef1ddb32f76"
}

chat_id的获取方式请参见群ID 说明。

发消息请求体示例

 {
	"receive_id": "oc_xxx",
	"content": "{\"chat_id\":\"oc_xxx\"}",
	"msg_type": "share_chat"
}

机器人必须在群名片所在的群内。

消息发送后的效果

分享个人名片 share_user

{
    "user_id": "ou_0dd200d32fda15216d2c2ef1ddb32f76"
}

机器人必须对用户可见

user_id只支持open_id

发消息请求体示例

{
	"receive_id": "oc_820faa21d7ed275b53d1727a0feaa917",
	"content": "{\"user_id\":\"ou_xxx\"}",
	"msg_type": "share_user"
}

消息发送后的效果

语音 audio

通过上传文件接口获取音频文件 file_key。

{
    "file_key": "75235e0c-4f92-430a-a99b-8446610223cg"     //文件key
}

发消息请求体示例

{
	"receive_id": "oc_xxx",
	"content": "{\"file_key\":\"file_v2_xxx\"}",
	"msg_type": "audio"
}

消息发送后的效果

视频 media

通过上传文件接口获取视频文件 file_key。通过上传图片接口获取视频封面image_key。

{
    "file_key": "75235e0c-4f92-430a-a99b-8446610223cg", //文件key
    "image_key": "img_xxxxxx"  // 视频封面图片key
}

发消息请求体示例

{
    "receive_id": "oc_xxx",
    "content": "{\"file_key\":\"file_v2_xxx\",\"image_key\":\"img_v2_xxx\"}",
    "msg_type": "media"
}

消息发送后的效果

文件 file

通过上传文件接口获取文件 file_key。

{
    "file_key": "75235e0c-4f92-430a-a99b-8446610223cg"
}

发消息请求体示例

{
	"receive_id": "oc_820faa21d7ed275b53d1727a0feaa917",
	"content": "{\"file_key\":\"file_v2_xxx\"}",
	"msg_type": "file"
}

消息发送后的效果

表情包 sticker

目前仅支持发送机器人收到的表情包，可通过接收消息事件的推送获取表情包 file_key。

{
    "file_key": "75235e0c-4f92-430a-a99b-8446610223cg"
}

发消息请求体示例

{
	"receive_id": "oc_xxx",
	"content": "{\"file_key\":\"file_v2_xxx\"}",
	"msg_type": "sticker"
}

消息发送后的效果

请求体示例#

各类型消息 json 结构#

文本 text#

富文本 post#

图片 image#

消息卡片 interactive#

分享群名片 share_chat#

分享个人名片 share_user#

语音 audio#

视频 media#

文件 file#

表情包 sticker#

请求体示例

各类型消息 json 结构

文本 text

富文本 post

图片 image

消息卡片 interactive

分享群名片 share_chat

分享个人名片 share_user

语音 audio

视频 media

文件 file

表情包 sticker