查询回调配置
读取当前租户的 Webhook 地址和启用状态。配置供新通知轮次读取，当前已开始轮次保留原地址。
GET /open/v1/settings/webhook
请求头
| 字段 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| X-App-Id | string | 是 | 平台appID，规范正int64，只传一次。 | 123456789012345001 |
| X-Timestamp | string | 是 | 当前秒级时间戳，服务器时间前后300秒内。 | 1893456000 |
| X-Sign | string | 是 | 本次HMAC-SHA256签名，64位小写十六进制；按签名规则生成。 | 按本次请求计算 |
| Authorization | string | 是 | 当前有效accessToken，格式为 Bearer 后加令牌。 | Bearer <ACCESS_TOKEN> |
认证只使用上表请求头；不要发送 Idempotency-Key。示例凭据、ID和地址是演示值，签名必须按实际参数和当前时间重新计算。
请求参数
无路径参数、无Query参数，额外查询键返回400；GET请求体必须为空。
业务规则
配置按租户保存，字段始终返回。关闭时 url 可为空；已开始推送轮次固定使用当时记录的 URL，不随配置变更而改写。
启用和修改使用设置回调配置；历史结果见通知列表。读取不会发出测试请求。
成功响应
HTTP 200，外层code=0、message为空字符串。
json
{
"code": 0,
"message": "",
"data": {
"url": "https://merchant.example.com/guiji/webhook",
"enabled": true
}
}| 字段 | 类型 | 必填 | 说明 | 示例值 |
|---|---|---|---|---|
| code | integer | 是 | 业务成功。 | 0 |
| message | string | 是 | 成功时为空字符串。 | "" |
| data | object | 是 | 当前租户的回调URL和启用状态。 | "见 JSON 示例" |
| data.url | string | 是 | 公网 HTTPS 回调地址，只允许默认端口或 443；不含用户凭据或片段。关闭时可为空字符串。 | "https://merchant.example.com/guiji/webhook" |
| data.enabled | boolean | 是 | 是否开启新通知轮次的正常投递；开启时必须有合法非空 URL。 | true |
失败响应
错误JSON没有data；HTTP状态与code一致。
| HTTP | 情况 |
|---|---|
| 400 | 参数缺失、类型/格式无效或存在不支持的字段 |
| 401 | accessToken、签名或签名时间窗口无效 |
| 403 | 租户停用、删除或过期 |
| 413 / 429 | 请求体过大 / 请求频率超限 |
| 500 / 503 / 504 | 内部依赖错误 / 资源或配置不可用 / 请求超时 |
json
{
"code": 401,
"message": "authentication required or expired",
"error_code": "TOKEN_INVALID_OR_EXPIRED",
"trace_id": "0123456789abcdef0123456789abcdef"
}通用错误说明Retry-After及重试处理；写请求不要因超时生成新的request_id。
业务错误示例
HTTP 404：租户没有回调配置记录。
json
{
"code": 404,
"message": "record not found",
"error_code": "RESOURCE_NOT_FOUND",
"trace_id": "0123456789abcdef0123456789abcdef"
}完整字段与状态
查看全部响应字段、嵌套对象及枚举 · 业务状态与处理 · 错误码排查。