更新消息流卡片按钮

为群组消息、机器人消息的消息流卡片添加、更新、删除快捷操作按钮。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/im/v2/chat_button
HTTP Method	PUT
接口频率限制	10 次/秒
支持的应用类型	custom,isv
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	im:app_feed_card:write 创建、更新、删除应用消息流卡片
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 contact:user.employee_id:readonly 获取用户 user ID

请求头

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

查询参数

名称	类型	必填	描述
user_id_type	string	否	用户 ID 类型 示例值：open_id 可选值有： - open_id: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - union_id: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - user_id: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？ 默认值：open_id 当值为 user_id，字段权限要求： contact:user.employee_id:readonly 获取用户 user ID

请求体

名称	类型	必填	描述
user_ids	string\[\]	否	用户 ID 列表（ID 类型与 user_id_type 的取值一致。如果是商店应用，因不支持获取用户 user ID 权限，所以无法使用 user_id 类型的用户 ID） 示例值：["ou_89553eda9014c201e6969b478895c276"] 数据校验规则： - 长度范围：1 ～ 20
chat_id	string	是	群 ID 示例值："oc_a0553eda9014c201e6969b478895c230"
buttons	open_app_feed_card_buttons	否	交互按钮（非必填字段，如未传入该字段，则不展示按钮；最多展示 2 个按钮）
└ buttons	open_app_feed_card_button\[\]	是	按钮组合，该字段为全量更新字段，若未传入字段原有值，则会清空字段数据。例如： - 在保持原有按钮的字段配置的前提下，新增一个按钮配置会添加一个按钮。 - 在原有按钮的字段配置上做更新，会更新该按钮。 - 清空原有按钮的字段配置，会删除该按钮。 数据校验规则： - 长度范围：0 ～ 2
└ multi_url	open_app_feed_card_url	否	跳转 URL（仅支持 https 协议）
└ url	string	否	默认 URL 示例值："https://www.feishu.cn/" 数据校验规则： - 最大长度：700 字符
└ android_url	string	否	Android 平台 URL 示例值："https://www.feishu.cn/" 数据校验规则： - 最大长度：700 字符
└ ios_url	string	否	iOS 平台 URL 示例值："https://www.feishu.cn/" 数据校验规则： - 最大长度：700 字符
└ pc_url	string	否	PC URL 示例值："https://www.feishu.cn/" 数据校验规则： - 最大长度：700 字符
└ action_type	string	是	交互类型（按钮交互方式可配置跳转 URL 页面，也可配置 webhook 回调） 示例值："url_page" 可选值有： - url_page: URL 页面 - webhook: 回调
└ text	open_app_feed_card_text	是	文字
└ text	string	是	文本 示例值："文本" 数据校验规则： - 长度范围：1 ～ 30 字符
└ button_type	string	否	按钮类型 示例值："default" 可选值有： - default: 默认 - primary: 主要 - success: 成功 默认值：default
└ action_map	map<string, string>	否	action 字典 示例值：{"foo": "bar"}

请求体示例

{
    "user_ids": [
        "ou_89553eda9014c201e6969b478895c276"
    ],
    "chat_id": "oc_a0553eda9014c201e6969b478895c230",
    "buttons": {
        "buttons": [
            {
                "multi_url": {
                    "url": "https://www.feishu.cn/",
                    "android_url": "https://www.feishu.cn/",
                    "ios_url": "https://www.feishu.cn/",
                    "pc_url": "https://www.feishu.cn/"
                },
                "action_type": "url_page",
                "text": {
                    "text": "文本"
                },
                "button_type": "default",
                "action_map": {
                    "foo": "bar"
                }
            }
        ]
    }
}

响应

响应体

名称	类型	描述
code	int	错误码，非 0 表示失败
msg	string	错误描述
data	\-	-
└ failed_user_reasons	failed_reason\[\]	失败的用户
└ error_code	int	错误码
└ error_message	string	错误信息
└ user_id	string	用户id

响应体示例

{
    "code": 0,
    "msg": "success",
    "data": {
        "failed_user_reasons": [
            {
                "error_code": 0,
                "error_message": "The user is not in the chat",
                "user_id": "ou_679eaeb583654bff73fefcc6e6371301"
            }
        ]
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	230001	param is invalid	根据 error message 确定错误的字段及原因
400	230027	no permission, bot not in the chat	检查 bot 是否在 chat 中