取消推送

取消推送接口，审核通过后待调度可以调用，发送过程中可以调用（会撤回已发送的消息），发送完成后可以需要推送（会撤回所有已发送的消息）。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/helpdesk/v1/notifications/:notification_id/cancel_send
HTTP Method	POST
接口频率限制	特殊频控
支持的应用类型	custom
权限要求 调用该 API 所需的权限。开启其中任意一项权限即可调用	helpdesk:all 更新服务台资源详情

请求头

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

Tip: 服务台请求Header中还需添加“服务台token”参数：

Key: X-Lark-Helpdesk-Authorization

Value: base64(helpdesk_id:helpdesk_token)，通过base64加密将helpdesk_id和helpdesk_token用':'连接而成的字符串。

了解更多：获取与使用服务台token

路径参数

名称	类型	描述
notification_id	string	唯一ID 示例值："6981801914270744596"

请求体

名称	类型	必填	描述
is_recall	boolean	是	是否召回已发送的消息,新人入职消息同样适用 示例值：true

请求体示例

{
    "is_recall": true
}

响应

响应体

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

响应体示例

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

错误码

HTTP状态码	错误码	描述	排查建议
400	154000	Bad request, please check your request body	请求不合法，请检查参数
401	154001	Unauthorized, please check you have the correct access	检查Authorization 和 X-Lark-Helpdesk-Authorization 是否正确，应用和服务台属于同一租户
403	154003	Please check you have the correct access	检查是否申请正确权限
404	154004	Resource not found	资源不存在，请检查ID值
405	154005	Method Forbidden	检查是否有权限创建推送
500	155000	Internal error	内部错误，请联系我们