> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coze.cn/llms.txt
> Use this file to discover all available pages before exploring further.

订阅回调事件。
## 接口描述 {#7ade3f98}
扣子编程当前支持的回调事件和使用限制请参考[回调事件](https://docs.coze.cn/dev_how_to_guides/add_callback#e63c85cc)。
## 基础信息 {#基础信息}
<!-- @cols-width: 180,680 -->
| | | \
|**请求方式** |POST |
|---|---|
| | | \
|**请求地址** |```Plain Text |\
| |https://api.coze.cn/v1/api_apps/:api_app_id/events |\
| |``` |\
| | |
| | | \
|**权限** |subscribeApiAppEvent |
| | | \
|**接口说明** |订阅回调事件。 |

## 请求参数 {#请求参数}
### Header {#Header}
<!-- @cols-width: 144,165,551 -->
| | | | \
|**参数** |**取值** |**说明** |
|---|---|---|
| | | | \
|Authorization |Bearer $Access_Token |用于验证客户端身份的访问令牌。你可以在扣子编程中生成访问令牌，详细信息，参考[准备工作](https://docs.coze.cn/developer_guides/preparation)。 |
| | | | \
|Content-Type |application/json |解释请求正文的方式。 |

### Path {#Path}
<!-- @cols-width: 124,122,87,165,349 -->
| | | | | | \
|**参数** |**类型** |**是否必选** |**示例** |**说明** |
|---|---|---|---|---|
| | | | | | \
|api_app_id |String |必选 |752690322532938**** |回调应用的 ID。你可以通过[查询回调应用列表](https://docs.coze.cn/developer_guides/list_callback_app) API 获取回调应用的 ID。 |

### Body {#Body}
<!-- @cols-width: 130,122,87,165,343 -->
| | | | | | \
|**参数** |**类型** |**是否必选** |**示例** |**说明** |
|---|---|---|---|---|
| | | | | | \
|event_types |Array of String |必选 |["bot.published"] |待订阅的回调事件列表，目前支持的事件类型包括： |\
| | | | | |\
| | | | |* `bot.published`：智能体发布事件。 |\
| | | | |* `bot.deleted`：智能体删除事件。 |\
| | | | |* `bot.unpublished`：智能体下架事件。 |\
| | | | |* `benefit.usage`：账单推送回调。 |\
| | | | |* `benefit.plugin.scale.requested`：申请插件扩容事件。 |\
| | | | |* `benefit.plugin.scale.expired`：插件扩容到期事件。 |

## 返回参数 {#返回参数}
<!-- @cols-width: 100,149,166,445 -->
| | | | | \
|**参数** |**类型** |**示例** |**说明** |
|---|---|---|---|
| | | | | \
|code |Long |0 |调用状态码。0 表示调用成功，其他值表示调用失败，你可以通过 msg 字段判断详细的错误原因。 |
| | | | | \
|msg |String |"" |状态信息。API 调用失败时可通过此字段查看详细错误信息。 |\
| | | |状态码为 0 时，msg 默认为空。 |
| | | | | \
|detail |Object of [ResponseDetail](#responsedetail) |{"logid":"20241210152726467C48D89D6DB2****"} |包含请求的详细信息，主要用于问题排查。 |

### ResponseDetail {#responsedetail}
<!-- @cols-width: 100,149,166,445 -->
| | | | | \
|**参数** |**类型** |**示例** |**说明** |
|---|---|---|---|
| | | | | \
|logid |String |20241210152726467C48D89D6DB2**** |本次请求的日志 ID。如果遇到异常报错场景，且反复重试仍然报错，可以根据此 logid 及错误码联系扣子团队获取帮助。详细说明可参考[获取帮助和技术支持](https://docs.coze.cn/guides/help_and_support)。 |

## 示例 {#示例}
### 请求示例 {#请求示例}
```JSON
POST 'https://api.coze.cn/v1/api_apps/752690322532938****/events' \
--header 'Authorization: Bearer czs_l8wA17hHrFts8ebCe9RxrjDBJvJJhXyxHQK1I8hEcu8cGsQm8LPI6Xs4LHyjd****' \
--header 'Content-Type: application/json'
{"event_types": ["bot.published", "bot.deleted"]}
```

### 返回示例 {#返回示例}
```JSON
{
  "code": 0,
  "msg": "",
  "detail": {
    "logid": "20250714194855054D95BD7A6DA74233D7"
  }
}
```

## 错误码 {#错误码}
如果成功调用扣子编程的 API，返回信息中 code 字段为 0。如果状态码为其他值，则表示接口调用失败。此时 msg 字段中包含详细错误信息，你可以参考[错误码](https://docs.coze.cn/developer_guides/coze_error_codes)文档查看对应的解决方法。