查詢回調模板
更新時間 2024-09-11 16:11:33
最近更新時間: 2024-09-11 16:11:33
分享文章
接口功能介紹
本接口用于查詢單個回調模板的信息。
接口約束
查詢模板前確保存在該回調模板。
請求參數說明:
String類型的參數,傳""等同于不傳。
Integer類型的參數,傳0等同于不傳。
Boolean類型的參數,傳false等同于不傳。
URI
GET /v2/callbackTemplate/*
路徑參數
| 參數 | 是否必填 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|---|
| TemplateId | 是 | String | 模板ID。 | 739943519892963328 |
Query參數
無
請求參數
請求頭header參數
無
請求體body參數
無
響應參數
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| statusCode | Integer | 響應狀態碼。 | 200 | |
| error | String | 錯誤碼,執行成功時,不返回該字段。 | VSS_0001 | |
| message | String | 響應信息。 | 請求成功 | |
| requestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b | |
| returnObj | Object | 響應數據,執行失敗時,不返回該字段。 | returnObj |
表 returnObj
| 參數 | 參數類型 | 說明 | 示例 | 下級對象 |
|---|---|---|---|---|
| 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。 | ||
| CreateTime | String | 創建時間。 | 1691992586 | |
| UpdateTime | String | 修改時間。 | 1691992586 | |
| RequestId | String | 請求ID。 | 362d4e78556b47129182d0881fade86b |
枚舉參數
無
請求示例
請求url
GET '/v2/callbackTemplate/739943519892963328'
請求頭header
無
請求體body
無
響應示例
{"statusCode": 200,"message": "請求成功","requestId": "aac5a1a85bf94d6a904139e1dc1d19ab","returnObj": {"TemplateId": "739943519892963328","TemplateName": "設備狀態回調模板","Description": "","CallbackKey": "123","DeviceStatusNotifyUrl": "//example.daliqc.cn/example","StreamStatusNotifyUrl": "","RecordNotifyUrl": "","AiEventNotifyUrl": "","CreateTime": "1691992586","UpdateTime": "1691992586","RequestId": "aac5a1a85bf94d6a904139e1dc1d19ab"}}
狀態碼
請參考
錯誤碼
請參考