文档

SetNotifyConfig - 设置智能体事件回调通知配置

更新时间:

启用或禁用智能体事件通知,并配置回调URL与关注的事件类型。

接口说明

请求说明

该接口用于设置智能体实例的事件通知配置。用户可以通过此接口来控制是否开启事件通知功能(EnableNotify),设置接收通知的回调地址(CallbackUrl),以及指定希望接收哪些类型的事件通知(EventTypes)。此外,还可以传递一个校验 Token(Token)以增强安全性。请求成功后,会返回一个唯一的请求 ID(RequestId)供后续追踪使用。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

当前API暂无授权信息透出。

请求参数

名称类型必填描述示例值
AIAgentIdstring

智能体 ID。

39f8e0bc005e4f309379701645f4****
EnableNotifyboolean

用于开启或关闭事件回调的开关。

true
CallbackUrlstring

用户希望接收回调通知的 URL。默认不填写。

http://customer.com/callback
EventTypesstring

事件类型,不填写则全选。

  • agent_start
  • agent_stop
  • error
agent_start,agent_stop,error
Tokenstring

回调的鉴权 token。发送回调请求时携带在请求头的 Authorization 字段中。默认不填写。

eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 Id

771A1414-27BF-53E6-AB73-EFCB*****ACF

示例

正常返回示例

JSON格式

{
  "RequestId": "771A1414-27BF-53E6-AB73-EFCB*****ACF"
}

错误码

访问错误中心查看更多错误码。