飞书智能伙伴Aily之飞书消息

飞书智能伙伴Aily之飞书消息

智能伙伴Aily手册精选NaN-NaN-NaN
产品功能
使用说明
发送消息
给指定用户或者会话发送消息。
使用该操作前提条件:
  • 给用户发送消息时,用户需要在机器人的 可用范围 内。
  • 给群组发送消息时,机器人需要在该群组中,且在群组内拥有发言权限。
操作配置
配置项
是否必填
说明
消息接收者类型
可选值有:用户 、群聊
消息接收者
你可以直接选择用户和群聊。若想采用ID的方式传入,用户ID的获取方式可参考文档 如何获取用户ID;群ID的获取方式可参考文档 如何获取群ID
消息类型
可选值有:文本、富文本、消息卡片
消息内容
消息内容
注意:文本消息请求体最大不能超过150KB
操作响应
响应字段
字段类型
说明
code
int
错误码,非 0 表示失败
msg
string
错误描述
data
message
-
message_id
string
消息id,说明参见:消息ID说明
root_id
string
根消息id,用于回复消息场景,说明参见:消息ID说明
parent_id
string
父消息的id,用于回复消息场景,说明参见:消息ID说明
thread_id
string
消息所属的话题 ID(不返回说明该消息非话题消息),说明参见:话题介绍
msg_type
string
消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考接收消息内容
create_time
string
消息生成的时间戳(毫秒)
update_time
string
消息更新的时间戳(毫秒)
deleted
boolean
消息是否被撤回
updated
boolean
消息是否被更新
chat_id
string
所属的群
sender
sender
发送者,可以是用户或应用
id
string
该字段标识发送者的id
id_type
string
该字段标识发送者的id类型
可选值有:
  • open_id
  • app_id
sender_type
string
该字段标识发送者的类型
可选值有:
  • user: 用户
  • app: 应用
  • anonymous: 匿名
  • unknown: 未知
tenant_key
string
为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
body
message_body
消息内容
content
string
消息内容,json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考:接收消息内容
mentions
mention[]
被@的用户或机器人的id列表
key
string
被@的用户或机器人的序号。例如,第3个被@到的成员,值为“@_user_3”
id
string
被@的用户或者机器人的open_id
id_type
string
被@的用户或机器人 id 类型,目前仅支持 open_id (什么是 Open ID?)
name
string
被@的用户或机器人的姓名
tenant_key
string
为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
upper_message_id
string
合并转发消息中,上一层级的消息id message_id,说明参见:消息ID说明
获取会话历史消息
获取会话(包括单聊、群组)的历史消息(聊天记录)。
使用该操作前提条件:
  • 获取消息时,机器人必须在被查询的群组中。
操作配置
配置项
是否必填
说明
获取会话历史消息的飞书群
你可以直接群聊。若想采用ID的方式传入,群ID的获取方式可参考文档 如何获取群ID
起始时间
历史信息的起始时间(秒级时间戳)
结束时间
历史信息的结束时间(秒级时间戳)
消息排序方式
消息排序方式
示例值:"ByCreateTimeAsc"
可选值有
  • ByCreateTimeAsc:按消息创建时间升序排列
  • ByCreateTimeDesc:按消息创建时间降序排列
默认值:ByCreateTimeAsc
分页大小
分页大小
示例值:20
默认值:20
数据校验规则
  • 取值范围:1 ~ 50
分页标记
分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 page_token,下次遍历可采用该 page_token 获取查询结果
示例值:"GxmvlNRvP0NdQZpa7yIqf_Lv_QuBwTQ8tXkX7w-irAghVD_TvuYd1aoJ1LQph86O-XImC4X9j9FhUPhXQDvtrQ=="
操作响应
响应字段
字段类型
说明
code
int
错误码,非 0 表示失败
msg
string
错误描述
data
-
-
has_more
boolean
是否还有更多项
page_token
string
分页标记,当 has_more 为 true 时,会同时返回新的 page_token,否则不返回 page_token
items
message[]
message[]
message_id
string
消息id,说明参见:消息ID说明
root_id
string
根消息id,用于回复消息场景,说明参见:消息ID说明
parent_id
string
父消息的id,用于回复消息场景,说明参见:消息ID说明
thread_id
string
消息所属的话题 ID
msg_type
string
消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考接收消息内容
create_time
string
消息生成的时间戳(毫秒)
update_time
string
消息更新的时间戳(毫秒)
deleted
boolean
消息是否被撤回或删除
updated
boolean
消息是否被更新
chat_id
string
所属的群
sender
sender
发送者,可以是用户或应用
id
string
该字段标识发送者的id
id_type
string
该字段标识发送者的id类型
可选值有:
  • open_id
  • app_id
sender_type
string
该字段标识发送者的类型
可选值有:
  • user: 用户
  • app: 应用
  • anonymous: 匿名
  • unknown: 未知
tenant_key
string
为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
body
message_body
消息内容
content
string
消息内容,json结构序列化后的字符串。不同msg_type对应不同内容。消息类型 包括:text、post、image、file、audio、media、sticker、interactive、share_chat、share_user等,类型定义请参考:接收消息内容
注意
  • 卡片消息内容与在卡片搭建工具中获取的卡片 JSON 不一致,暂不支持返回原始卡片 JSON
mentions
mention[]
被@的用户或机器人的id列表
key
string
被@的用户或机器人的序号。例如,第3个被@到的成员,值为“@_user_3”
id
string
被@的用户或者机器人的open_id
id_type
string
被@的用户或机器人 id 类型,目前仅支持 open_id (什么是 Open ID?)
name
string
被@的用户或机器人的姓名
tenant_key
string
为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识
upper_message_id
string
合并转发消息中,上一层级的消息id message_id,说明参见:消息ID说明
先进生产力和业务协同平台
联系我们立即试用

先进团队,先用飞书

欢迎联系我们,飞书效能顾问将为您提供全力支持
分享先进工作方式
输送行业最佳实践
全面协助组织提效
联系我们立即试用