修改回調模板
更新時間 2024-09-11 16:11:32
最近更新時間: 2024-09-11 16:11:32
分享文章
接口功能介紹
本接口用于修改回調模板。
接口約束
- 修改模板前確保存在該回調模板。
2. url會進行批量修改，未傳參的url將被置空。
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
PUT /v2/callbackTemplate/*
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| TemplateId | 是 | String | 模板ID。 | 739943519892963328 |
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| Description | 否 | String | 模板描述，長度小于等于256個字符。 | 回調模板 | |
| CallbackKey | 是 | String | 回調Key。 | abc123 | |
| DeviceStatusNotifyUrl | 否 | String | 設備狀態回調URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少選擇一種。 | ||
| StreamStatusNotifyUrl | 否 | String | 流狀態回調URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少選擇一種。 | ||
| RecordNotifyUrl | 否 | String | 錄制回調URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少選擇一種。 | ||
| AiEventNotifyUrl | 否 | String | AI回調URL。DeviceStatusNotifyUrl，StreamStatusNotifyUrl，RecordNotifyUrl，SnapshotNotifyUrl，AiEventNotifyUrl至少選擇一種。 |
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| TemplateId | String | 模板ID。 | 739943519892963328 | |
| RequestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b |
枚舉參數
無
請求示例
請求url
PUT '/v2/callbackTemplate/739943519892963328'
請求頭header
無
請求體body
{"CallbackKey": "123","DeviceStatusNotifyUrl": "//example.daliqc.cn/example"}
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "18374a7365694d13837d5d69747280d6","returnObj": {"TemplateId": "739943519892963328","RequestId": "18374a7365694d13837d5d69747280d6"}}
狀態碼
請參考
錯誤碼
請參考
