请求方式	DELETE
请求地址	`https://api.coze.cn/v1/api_apps/:api_app_id/events`
权限	`unsubscribeApiAppEvent` 确保调用该接口使用的服务令牌开通了 `unsubscribeApiAppEvent` 权限，详细信息参考鉴权方式。
接口说明	取消订阅事件。

请求参数

参数	取值	说明
Authorization	Bearer $Access_Token	用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考准备工作。
Content-Type	application/json	解释请求正文的方式。

Path

参数	类型	是否必选	示例	说明
api_app_id	String	必选	3336789234***	回调应用的 ID。你可以通过查询回调应用列表 API 获取回调应用的 ID。

Body

参数	类型	是否必选	示例	说明
event_types	Array of String	必选	[“bot.published”]	待取消订阅的回调事件类型，目前支持的事件类型包括： `bot.published`：智能体发布事件。 `bot.deleted`：智能体删除事件。 `bot.unpublished`：智能体下架事件。 `benefit.usage`：账单推送回调。 `benefit.plugin.scale.requested`：申请插件扩容事件。 `benefit.plugin.scale.expired`：插件扩容到期事件。

参数

类型

是否必选

示例

说明

event_types

Array of String

必选

[“bot.published”]

待取消订阅的回调事件类型，目前支持的事件类型包括：

bot.published：智能体发布事件。
bot.deleted：智能体删除事件。
bot.unpublished：智能体下架事件。
benefit.usage：账单推送回调。
benefit.plugin.scale.requested：申请插件扩容事件。
benefit.plugin.scale.expired：插件扩容到期事件。

返回参数

参数	类型	示例	说明
code	Long	0	调用状态码。0 表示调用成功，其他值表示调用失败，你可以通过 msg 字段判断详细的错误原因。
msg	String	“”	状态信息。API 调用失败时可通过此字段查看详细错误信息。状态码为 0 时，msg 默认为空。
detail	Object of ResponseDetail	{“logid”:“20241210152726467C48D89D6DB2****”}	包含请求的详细信息，主要用于问题排查。

ResponseDetail

参数	类型	示例	说明
logid	String	20241210152726467C48D89D6DB2****	本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考获取帮助和技术支持。

示例

请求示例

DELETE 'https://api.coze.cn/v1/api_apps/7526903225329385****/events' \
--header 'Authorization: Bearer czs_l8wA17hHrFts8ebCe9RxrjDBJvJJhXyxHQK1I8hEcu8cGsQm8LPI6Xs4LHyjd****' \
--header 'Content-Type: application/json'
{"event_types": ["bot.published"]}

返回示例

{
  "detail": {
    "logid": "202507141950092C6B40*****"
  },
  "code": 0,
  "msg": ""
}

错误码

如果成功调用扣子编程的 API，返回信息中 code 字段为 0。如果状态码为其他值，则表示接口调用失败。此时 msg 字段中包含详细错误信息，你可以参考错误码文档查看对应的解决方法。