如果三方付费插件支持扩容,插件开发者可以订阅插件扩容到期回调事件,当扩容申请到期或用户主动取消扩容时,扣子编程会向指定的回调地址推送回调消息,消息中包含插件扩容的基本信息。订阅回调的具体操作请参见订阅回调。
说明
插件扩容到期回调仅支持普通回调,不支持渠道回调。
仅插件开发者可订阅,当扩容申请到期或用户主动取消扩容时,对应的回调地址会收到插件扩容到期回调事件。
回调消息的结构体 Body 中包含两个主要字段:header 和 event。
header参数的参数说明请参见回调事件。event 参数中包括以下参数:
|
字段 |
类型 |
说明 |
|---|---|---|
|
apply_id |
String |
本次扩容到期申请的 ID。 |
|
resource_id |
String |
对应插件的 ID。 |
|
applicant_info.user_id |
Integer |
申请插件扩容的扣子用户 ID。 |
|
applicant_info.user_name |
String |
申请插件扩容的扣子用户名称。 |
|
extension_type |
String |
扩容类型, 当前仅支持 QPS(Queries Per Second),即每秒最大请求数。 |
|
expired_capacity |
Number |
本次到期所扣除的 QPS 容量。 |
|
current_capacity |
Number |
释放后,插件当前可用的 QPS 限额。 |
回调结构体示例:
{
"header": {
"event_type": "benefit.plugin.scale.expired", // 事件类型:插件扩容到期事件
"event_id": "6c2c25d4-e5c1-4bb4-9757-923ce88ddd12-7546444412004335643", // 此次触发的事件唯一ID,用户应该用这个ID做去重
"created_at": 1757412006297,
"coze_account_id": "", // Coze账号ID
"api_app_id": "754644441200***" // 回调应用的 ID
},
"event": {
"applicant_info": { // 扩容申请人信息
"user_id": 2102717852, // 申请人的扣子用户ID
"user_name": "" // 申请人的扣子用户名
},
"apply_id": "75476401436293**", // 扩容申请单号
"resource_id": "75460679235388**", // 对应插件的 ID。
"extension_type": "QPS", // 扩容类型
"expired_capacity": 5, // 本次到期所扣除的 QPS 容量
"current_capacity": 21 // 释放后,插件当前可用的 QPS 限额
}
}
开发者服务器收到插件扩容到期回调事件后,应在 3 秒内响应,并返回 HTTP 状态码 200。