添加跟随气泡

调用该接口在最新一条消息下方添加气泡样式的内容，当消息接收者点击气泡或者新消息到达后，气泡消失。

前提条件

• 应用需要开启机器人能力。

• 跟随气泡的效果在飞书客户端 v7.20 及以上版本生效。

• 仅支持在当前机器人与用户单聊的消息上添加跟随气泡，且消息需要符合：

  • 消息是机器人发送的。
  • 消息是会话内最新的消息。
  • 消息发送后未超过 600 秒。

注意事项

添加跟随气泡后，会话内的用户点击气泡会自动转换为该用户发送的一条消息，你可以为应用订阅接收消息事件，接收用户发送的消息并判断是否为跟随气泡的内容。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v1/messages/:message_id/push_follow_up
HTTP Method	POST
接口频率限制	1000 次/分钟、50 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可	im:message 获取与发送单聊、群组消息 im:message:send_as_bot 以应用的身份发消息

请求头

名称	类型	必填	描述
Authorization	string	是	tenant_access_token 值格式："Bearer access_token" 示例值："Bearer t-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

路径参数

名称	类型	描述
message_id	string	机器人发送的消息 ID。ID 获取方式： - 调用发送消息接口后，从响应结果的 message_id 参数获取。 - 监听接收消息事件，当触发该事件后可以从事件体内获取消息的 message_id。 - 调用获取会话历史消息接口，从响应结果的 message_id 参数获取。 示例值："om_3210a18894e206715a4359115f4cf2f5"

请求体

名称	类型	必填	描述
follow_ups	follow_up\[\]	是	跟随气泡列表。 数据校验规则： - 长度范围：1 ～ 3
└ content	string	是	气泡的内容。 示例值："你好" 数据校验规则： - 长度范围：1 ～ 200 字符
└ i18n_contents	i18n_content\[\]	否	气泡的多语言内容。 数据校验规则： - 长度范围：0 ～ 50
└ content	string	是	language 参数对应的内容。 示例值："hello" 数据校验规则： - 长度范围：1 ～ 200 字符
└ language	string	是	语言类型。 示例值："en_us" 可选值有： - en_us: 英文 - zh_cn: 简体中文 - zh_hk: 繁体中文-香港 - zh_tw: 繁体中文-台湾 - ja_jp: 日语 - id_id: 印尼语 - vi_vn: 越南语 - th_th: 泰语 - pt_br: 葡萄牙语 - es_es: 西班牙语 - ko_kr: 韩语 - de_de: 德语 - fr_fr: 法语 - it_it: 意大利语 - ru_ru: 俄语 - ms_my: 马来语

请求体示例

{
    "follow_ups": [
        {
            "content": "你好",
            "i18n_contents": [
                {
                    "content": "hello",
                    "language": "en_us"
                }
            ]
        }
    ]
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {}
}

错误码

HTTP状态码	错误码	描述	排查建议
400	230001	Your request contains an invalid request parameter.	参数错误，可根据接口实际返回的错误信息，并参考接口文档内容，检查输入参数是否填写错误。
400	230002	expired message.	消息已过期。已发送超过 600 秒的消息无法再添加跟随气泡。
400	230003	only support p2p chat.	仅支持在当前机器人与用户单聊的消息上添加跟随气泡。
400	230004	invisible message.	所操作的消息对当前机器人不可见，无法执行操作。
400	230005	user is not visible to bot.	当前机器人对用户不可见，无法执行操作。
400	230006	only support latest message.	仅支持在会话中的最新一条消息上添加跟随气泡。
400	230007	invalid follow up.	气泡内容无效。你可以根据文档提供的参数描述，传入正确的气泡内容。
400	230008	follow up already exist.	指定消息已添加跟随气泡，无法执行本次操作。

更多错误码信息，参见通用错误码。