查詢回調模板列表
更新時間 2024-09-11 16:11:33
最近更新時間: 2024-09-11 16:11:33
分享文章
接口功能介紹
本接口用于查詢回調模板列表。
接口約束
請求參數說明：
String類型的參數，傳""等同于不傳。
Integer類型的參數，傳0等同于不傳。
Boolean類型的參數，傳false等同于不傳。
URI
GET /v2/callbackTemplate
路徑參數
無
Query參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| TemplateName | 否 | String | 根據TemplateName查詢。 | 回調模板 | |
| SortBy | 否 | String | 選擇按一個字段排序，默認為CreatedTime，按照創建時間排序。取值：TemplateName(模板名稱)，CreatedTime(創建時間)。 | CreatedTime | |
| SortDirection | 否 | String | 排序方式，默認升序。取值：asc(升序)，desc(降序)。 | asc | |
| PageNum | 否 | Integer | 第幾個分頁，默認為1。 | 1 | |
| PageSize | 否 | Integer | 分頁大小，默認為20，取值范圍為1～1000。 | 20 |
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼，執行成功時，不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據，執行失敗時，不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| PageNum | Integer | 第幾個分頁。 | 1 | |
| PageSize | Integer | 分頁大小。 | 10 | |
| TotalPage | Integer | 分頁總數。 | 1 | |
| TotalNum | Integer | 模板總數。 | 10 | |
| CallbackTemplates | Array of Objects | 模板列表。 | CallbackTemplate | |
| RequestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b |
表 CallbackTemplate
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| TemplateId | String | 模板ID。 | 739943519892963328 | |
| TemplateName | String | 模板名稱。 | test | |
| Description | String | 模板描述。 | 描述 | |
| CallbackKey | String | 回調KEY。 | xxx | |
| DeviceStatusNotifyUrl | String | 設備狀態回調URL。 | ||
| StreamStatusNotifyUrl | String | 流狀態回調URL。 | ||
| RecordNotifyUrl | String | 錄制回調URL。 | ||
| AiEventNotifyUrl | String | AI回調URL。 | ||
| CreatedTime | String | 創建時間。 | 1691992586 | |
| UpdatedTime | String | 更新時間。 | 1691992586 |
枚舉參數
無
請求示例
請求url
GET '/v2/callbackTemplate?PageNum=1&PageSize=20'
請求頭header
無
請求體body
無
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "8f5de39981174c32b3a70f5c6302e22c","returnObj": {"PageNum": 1,"PageSize": 20,"TotalPage": 1,"TotalNum": 1,"CallbackTemplates": [{"TemplateId": "739943519892963328","TemplateName": "設備狀態回調模板","Description": "","CallbackKey": "123","DeviceStatusNotifyUrl": "//example.daliqc.cn/example","StreamStatusNotifyUrl": "","RecordNotifyUrl": "","AiEventNotifyUrl": "","CreateTime": "1691992586","UpdateTime": "1691992586"}],"RequestId": "8f5de39981174c32b3a70f5c6302e22c"}}
狀態碼
請參考
錯誤碼
請參考
