使用说明
发送消息
给指定用户或者会话发送消息。
使用该操作前提条件:
- 应用需要开启 机器人能力。
- 给用户发送消息时,用户需要在机器人的 可用范围 内。
- 给群组发送消息时,机器人需要在该群组中,且在群组内拥有发言权限。
操作配置
操作响应
响应字段 | | | 字段类型 | 说明 |
code | | | int | 错误码,非 0 表示失败 |
msg | | | string | 错误描述 |
data | | | message | - |
| message_id | | string | |
| root_id | | string | |
| parent_id | | string | |
| thread_id | | string | |
| msg_type | | string | |
| create_time | | string | 消息生成的时间戳(毫秒) |
| update_time | | string | 消息更新的时间戳(毫秒) |
| deleted | | boolean | 消息是否被撤回 |
| updated | | boolean | 消息是否被更新 |
| chat_id | | string | 所属的群 |
| sender | | sender | 发送者,可以是用户或应用 |
| | id | string | 该字段标识发送者的id |
| | id_type | string | 该字段标识发送者的id类型 可选值有:
|
| | sender_type | string | 该字段标识发送者的类型 可选值有:
|
| | 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 | |
| | name | string | 被@的用户或机器人的姓名 |
| | tenant_key | string | 为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识 |
| upper_message_id | | string |
获取会话历史消息
获取会话(包括单聊、群组)的历史消息(聊天记录)。
使用该操作前提条件:
- 应用需要开启机器人能力。
- 获取消息时,机器人必须在被查询的群组中。
操作配置
配置项 | 是否必填 | 说明 |
获取会话历史消息的飞书群 | 是 | |
起始时间 | 否 | 历史信息的起始时间(秒级时间戳) |
结束时间 | 否 | 历史信息的结束时间(秒级时间戳) |
消息排序方式 | 否 | 消息排序方式 示例值:"ByCreateTimeAsc" 可选值有:
默认值:ByCreateTimeAsc |
分页大小 | 否 | 分页大小 示例值:20 默认值:20 数据校验规则:
|
分页标记 | 否 | 分页标记,第一次请求不填,表示从头开始遍历;分页查询结果还有更多项时会同时返回新的 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 | |
| | root_id | | string | |
| | parent_id | | string | |
| | thread_id | | string | 消息所属的话题 ID |
| | msg_type | | string | |
| | create_time | | string | 消息生成的时间戳(毫秒) |
| | update_time | | string | 消息更新的时间戳(毫秒) |
| | deleted | | boolean | 消息是否被撤回或删除 |
| | updated | | boolean | 消息是否被更新 |
| | chat_id | | string | 所属的群 |
| | sender | | sender | 发送者,可以是用户或应用 |
| | | id | string | 该字段标识发送者的id |
| | | id_type | string | 该字段标识发送者的id类型 可选值有:
|
| | | sender_type | string | 该字段标识发送者的类型 可选值有:
|
| | | 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 | |
| | | name | string | 被@的用户或机器人的姓名 |
| | | tenant_key | string | 为租户在飞书上的唯一标识,用来换取对应的tenant_access_token,也可以用作租户在应用里面的唯一标识 |
| | upper_message_id | | string |