子程序名	返回值类型	公开	备注
编码_MP3到skil	文本型		语音编码，成功返回路径，失败返回原因，为MP3设计，其他格式自行尝试
参数名	类型	参考	可空	数组	备注
file_path	文本型				注意文件后缀必须和文件格式相对应

子程序名	返回值类型	公开	备注
发送频道消息	文本型		发送频道消息，成功返回消息ID，失败返回原因
参数名	类型	参考	可空	数组	备注
channel_id	文本型				子频道ID
content	文本型				选填，消息内容，文本内容，支持内嵌格式
embed	文本型		√		选填，embed 消息，一种特殊的 ark，详情参考Embed消息
ark	文本型		√		MessageArk ark消息对象，选填，ark 消息
message_reference	文本型		√		MessageReference 引用消息对象，选填，引用消息
image	文本型		√		选填，图片url地址，平台会转存该图片，用于下发图片消息
msg_id	文本型		√		选填，要回复的消息id(Message.id)
event_id	文本型		√		选填，要回复的事件id
markdown	文本型		√		MessageMarkdown markdown，消息对象 选填，markdown 消息

子程序名	返回值类型	公开	备注
发送群聊消息	文本型		发送群聊消息，成功返回消息ID，失败返回原因
参数名	类型	参考	可空	数组	备注
group_openid	文本型				群聊ID
content	文本型				文本内容
msg_type	整数型				消息类型：0 是文本，2 是 markdown， 3 ark，4 embed，7 media 富媒体
markdown	文本型		√		Markdown对象
keyboard	文本型		√		Keyboard对象
ark	文本型		√		Ark对象
media	文本型		√		富媒体单聊的file_info
message_reference	文本型		√		【暂未支持】消息引用
event_id	文本型		√		前置收到的事件 ID，用于发送被动消息，支持事件："INTERACTION_CREATE"、"C2C_MSG_RECEIVE"、"FRIEND_ADD"
msg_id	文本型		√		前置收到的用户发送过来的消息 ID，用于发送被动（回复）消息
msg_seq	整数型		√		回复消息的序号，与 msg_id 联合使用，避免相同消息id回复重复发送，不填默认是1。相同的 msg_id + msg_seq 重复发送会失败。

子程序名	返回值类型	公开	备注
发送私聊流式消息	文本型		发送私聊流式消息，成功返回消息ID，失败返回原因，续接消息请在10秒完成
参数名	类型	参考	可空	数组	备注
union_openid	文本型				触发人ID
content	文本型				文本内容
state	整数型		√		流式消息状态 1生成流式消息 10结束流式消息
id	文本型		√		流式消息ID 首条不用写 续接需要填写上条的消息ID
index	整数型		√		流式消息序号 从0开始 重新生成填写1
reset	逻辑型		√		重新生成传入真，续接传入假
msg_id	文本型				前置收到的用户发送过来的消息 ID，用于发送被动（回复）消息
msg_seq	整数型		√		回复消息的序号，与 msg_id 联合使用，避免相同消息id回复重复发送，不填默认是1。相同的 msg_id + msg_seq 重复发送会失败。

子程序名	返回值类型	公开	备注
发送私聊消息	文本型		发送私聊消息，成功返回消息ID，失败返回原因
参数名	类型	参考	可空	数组	备注
union_openid	文本型				触发人ID
content	文本型				文本内容
msg_type	整数型				消息类型：0 是文本，2 是 markdown， 3 ark，4 embed，7 media 富媒体
markdown	文本型		√		Markdown对象
keyboard	文本型		√		Keyboard对象
ark	文本型		√		Ark对象
media	文本型		√		富媒体单聊的file_info
message_reference	文本型		√		【暂未支持】消息引用
event_id	文本型		√		前置收到的事件 ID，用于发送被动消息，支持事件："INTERACTION_CREATE"、"C2C_MSG_RECEIVE"、"FRIEND_ADD"
msg_id	文本型		√		前置收到的用户发送过来的消息 ID，用于发送被动（回复）消息
msg_seq	整数型		√		回复消息的序号，与 msg_id 联合使用，避免相同消息id回复重复发送，不填默认是1。相同的 msg_id + msg_seq 重复发送会失败。

子程序名	返回值类型	公开	备注
获取access_token	文本型		返回最新未失效的access_token，用于调用官方API鉴权

子程序名	返回值类型	公开	备注
获取AppID	文本型		返回当前机器人AppID

子程序名	返回值类型	公开	备注
获取SDK版本	文本型		获取SDK版本。也可以直接使用SDKver常量

子程序名	返回值类型	公开	备注
获取插件数据目录	文本型		建议将设置文件之类的都写这里面，结果结尾带\

子程序名	返回值类型	公开	备注
获取框架版本	文本型		获取框架版本。

子程序名	返回值类型	公开	备注
获取群聊消息ID	文本型		返回最新未失效的群聊消息ID，获取失败返回空
参数名	类型	参考	可空	数组	备注
group_openid	文本型				群聊ID

子程序名	返回值类型	公开	备注
获取私聊消息ID	文本型		返回最新未失效的私聊消息ID，获取失败返回空
参数名	类型	参考	可空	数组	备注
union_openid	文本型				好友ID

子程序名	返回值类型	公开	备注
获取运行信息	逻辑型
参数名	类型	参考	可空	数组	备注
运行信息	云梦_运行信息

子程序名	返回值类型	公开	备注
上传群聊文件	文本型		上传群聊文件，用于富媒体消息media字段，语音请进行silk编码
参数名	类型	参考	可空	数组	备注
group_openid	文本型				群聊ID
file_type	文本型				文件类型，1图片，2视频，3语音
file_path	文本型				文件路径，可为文件url

子程序名	返回值类型	公开	备注
上传私聊文件	文本型		上传私聊文件，用于富媒体消息media字段，语音请进行silk编码
参数名	类型	参考	可空	数组	备注
union_openid	文本型				好友ID
file_type	文本型				文件类型，1图片，2视频，3语音
file_path	文本型				文件路径，可为文件url

子程序名	返回值类型	公开	备注
上传图床	文本型		成功返回图片URL，失败返回空
参数名	类型	参考	可空	数组	备注
图片路径	文本型				图片路径

子程序名	返回值类型	公开	备注
输出日志			输出日志
参数名	类型	参考	可空	数组	备注
输出内容	文本型
文本颜色	整数型		√
背景颜色	整数型		√

子程序名	返回值类型	公开	备注
重启框架

数据类型名	公开	备注
云梦_频道消息数据	√	频道消息数据[完全官方格式]
成员名	类型	传址	数组	备注
op	整数型			指的是 opcode，参考连接维护
s	整数型			下行消息都会有一个序列号，标识消息的唯一性，客户端需要再发送心跳的时候，携带客户端收到的最新的s
t	文本型			代表事件类型。主要用在op为 0 Dispatch 的时候
id	文本型			注意，这不是发送消息是传入的消息ID
d_attachments_content_type	文本型		100	接收图片 类型 image/jpeg
d_attachments_filename	文本型		100	接收图片 名称
d_attachments_height	文本型		100	接收图片
d_attachments_id	文本型		100	接收图片
d_attachments_size	文本型		100	接收图片
d_attachments_url	文本型		100	接收图片
d_attachments_width	文本型		100	接收图片
d_author_avatar	文本型
d_author_bot	逻辑型
d_author_id	文本型
d_author_union_openid	文本型
d_author_username	文本型
d_channel_id	文本型			子频道ID
d_content	文本型
d_guild_id	文本型			频道ID
d_id	文本型			用于回复消息的ID
d_member_joined_at	文本型
d_member_nick	文本型
d_member_roles_1	文本型
d_member_roles_2	文本型
d_member_roles_3	文本型
d_mentions_avatar	文本型
d_mentions_bot	逻辑型
d_mentions_id	文本型
d_mentions_username	文本型
d_seq	整数型
d_seq_in_channel	文本型
d_timestamp	文本型

数据类型名	公开	备注
云梦_群聊消息数据	√	群聊消息数据[完全官方格式]
成员名	类型	传址	数组	备注
op	整数型			指的是 opcode，参考连接维护
s	整数型			下行消息都会有一个序列号，标识消息的唯一性，客户端需要再发送心跳的时候，携带客户端收到的最新的s
t	文本型			代表事件类型。主要用在op为 0 Dispatch 的时候
id	文本型			注意，这不是发送消息是传入的消息ID
d_attachments_content_type	文本型		100	接收图片 类型 image/jpeg
d_attachments_filename	文本型		100	接收图片 名称
d_attachments_height	文本型		100	接收图片
d_attachments_id	文本型		100	接收图片
d_attachments_size	文本型		100	接收图片
d_attachments_url	文本型		100	接收图片
d_attachments_width	文本型		100	接收图片
d_author_id	文本型
d_author_member_openid	文本型			相同 bot 在不同的群，获取到同一个用户在群内的唯一识别号 openid 不一样，称为 member_openid
d_author_union_openid	文本型			不同 bot 在单聊场景，获取到的用户唯一识别 openid 不一样，称为 user_openid
d_content	文本型
d_group_id	文本型
d_group_openid	文本型			不同 bot 在群聊场景，获取到的群唯一识别号 openid 不一样，称为 group_openid
d_id	文本型			用于回复消息的ID
d_message_scene_callback_data	文本型
d_message_scene_source	文本型
d_timestamp	文本型

数据类型名	公开	备注
云梦_私聊消息数据	√	私聊消息数据[完全官方格式]
成员名	类型	传址	数组	备注
op	整数型			指的是 opcode，参考连接维护
s	整数型			下行消息都会有一个序列号，标识消息的唯一性，客户端需要再发送心跳的时候，携带客户端收到的最新的s
t	文本型			代表事件类型。主要用在op为 0 Dispatch 的时候
id	文本型			注意，这不是发送消息是传入的消息ID
d_attachments_content_type	文本型		100	接收图片 类型 image/jpeg
d_attachments_filename	文本型		100	接收图片 名称
d_attachments_height	文本型		100	接收图片
d_attachments_id	文本型		100	接收图片
d_attachments_size	文本型		100	接收图片
d_attachments_url	文本型		100	接收图片
d_attachments_width	文本型		100	接收图片
d_author_id	文本型
d_author_union_openid	文本型
d_author_user_openid	文本型			不同 bot 在单聊场景，获取到的用户唯一识别 openid 不一样，称为 user_openid
d_content	文本型
d_id	文本型			用于回复消息的ID
d_message_scene_callback_data	文本型
d_message_scene_source	文本型
d_timestamp	文本型

数据类型名	公开	备注
云梦_运行信息	√	需要调用 获取运行信息 才有值
成员名	类型	传址	数组	备注
在线	逻辑型			在线状态，当然，肯定是在线的啦
头像	文本型			头像链接
昵称	文本型
启动时间	文本型			软件启动事件戳
接收消息	文本型			收到的消息，包含群聊，好友，频道
发送消息	文本型			发送的消息，包含群聊，好友，频道
运行时长	文本型			精确到分，格式 x天x时x分
设备代码	文本型			设备码，没什么用
设备地址	文本型			设备外网IP
应用数量	文本型

常量名称	常量值	公开	备注
SDKver	“1.1.2”	√	SDK版本
模板_ark_大图	<文本长度: 156>	√
模板_ark_图文	<文本长度: 654>	√
模板_ark_文字	<文本长度: 446>	√
模板_md_单独按钮	“{"id": "[ID]"}”	√
消息处理_忽略	0	√
消息处理_拦截	1	√	.版本 2

i云梦版权所有
云梦官网	yunbot.top