文档

DescribeNotifyConfig - 查询智能体通知配置

更新时间:

获取指定智能体的事件回调设置。

接口说明

请求说明

  • 功能描述:此接口用于查询指定智能体(AIAgent)的事件回调配置详情。

调试

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

授权信息

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

请求参数

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

智能体 ID。

39f8e0bc005e4f309379701645f4****

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

请求 Id。

7B117AF5-2A16-412C-B127-FA6175ED1AD0
EnableNotifyboolean

用于开启或关闭通知的开关。

true
CallbackUrlstring

用户希望接收回调通知的 URL。

http://customer.com/callback
EventTypesstring

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

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

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

eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx

示例

正常返回示例

JSON格式

{
  "RequestId": "7B117AF5-2A16-412C-B127-FA6175ED1AD0",
  "EnableNotify": true,
  "CallbackUrl": "http://customer.com/callback",
  "EventTypes": "agent_start,agent_stop,error",
  "Token": "eyJhcHBpZCI6ICIxMjM0MTIzNxxxxx"
}

错误码

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