删除仅特定人可见的消息卡片
当发送的仅特定人可见的卡片消息已交互完成,可调用本接口删除该卡片。删除后将不会在对应设备上留下任何痕迹。
前提条件
- 应用需要启用机器人能力。
- 应用机器人需要在待操作的消息卡片所在的群聊中。
请求
| 项目 | 值 |
|---|---|
| HTTP URL | https://open.feishu.cn/open-apis/ephemeral/v1/delete |
| HTTP Method | POST |
| 接口频率限制 | 1000 次/分钟、50 次/秒 |
| 支持的应用类型 | custom,isv |
| 权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用 开启任一权限即可 | im:message 获取与发送单聊、群组消息 im:message:send_as_bot 以应用的身份发消息 im:message:update 更新消息 |
请求头
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Authorization | string | 是 | tenant_access_token 以应用身份调用 API,可读写的数据范围由应用自身的数据权限范围决定。参考自建应用获取 tenant_access_token或商店应用获取 tenant_access_token。 值格式:"Bearer access_token" 示例值:"Bearer t-g1044qeGEDXTB6NDJOGV4JQCYDGHRBARFTGT1234" |
| Content-Type | string | 是 | 固定值:"application/json; charset=utf-8" |
请求体
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| message_id | string | 是 | 消息 ID。调用发送仅特定人可见的消息卡片接口后,在返回结果中获取。 示例值:om_5ad573a6411d72b8305fda3a9c15c70e |
请求体示例
json
{
"message_id": "om_xxxxxxxxxxxx"
}响应
响应体
| 参数 | 类型 | 说明 |
|---|---|---|
| code | int | 返回码,非 0 表示失败 |
| msg | string | 返回码描述 |
响应体示例
json
{
"code": 0,
"msg": "ok"
}错误码
| 错误码 | 说明 | 排查建议 |
|---|---|---|
| 18051 | 消息已删除 | 消息已被删除,无法继续删除 |
其他通用错误码可参考:服务端错误码说明
