更新回調模板
更新時間 2023-11-09 14:59:43
最近更新時間: 2023-11-09 14:59:43
分享文章
接口功能介紹
支持直播錄制、直播截圖和直播審核等功能的回調模板的更新。
使用說明
(1)注意事項:本接口為 全量更新接口 ,即入參不止是變更參數值,未變更的也需要入參
(2)可通過查詢域名回調配置查詢域名已綁定的回調模板配置,以判斷是否對其中模板ID進行參數變更。
(3)可通過查詢回調模板列表查詢已新增的回調模板信息,以判斷是否對其中模板ID進行參數變更。
接口詳情
請求方式:POST
請求路徑:/live/notify-template/update-notify-template
請求JSON參數
| 代碼 | 類型 | 字段名稱 | 是否必須 | 說明 |
|---|---|---|---|---|
| TemplateID | string | 模板ID | 是 | 已創建成功的回調模板ID |
| Params | string | 模板參數 | 是 | 參數值的修改為全量更新 若只變更部分參數值,可先查詢模板ID下各參數值,將變更后的全集作為入參值。 參數列表詳見下文說明 |
回調模板參數Params
| 代碼 | 類型 | 字段名稱 | 是否必須 | 說明 |
|---|---|---|---|---|
| RecordNotifyUrl | string | 錄制回調URL | 否 | 1至255個字符 |
| SnapshotNotifyUrl | string | 截圖回調URL | 否 | 1至255個字符 |
| IdentifyNotifyUrl | string | 審核回調URL | 否 | 1至255個字符 |
| CallbackReqAuth | string | 回調鑒權開關 | 否 | 取值:on:開啟;off:關閉。 選擇開啟時,鑒權密鑰必填。關閉時,鑒權密鑰為空 |
| CallbackAuthKey | string | 回調鑒權密鑰 | 否 | 1至255個字符 |
響應JSON參數
| 代碼 | 類型 | 字段名稱 |
|---|---|---|
| code | int | 狀態碼 |
| message | string | 描述信息 |
| TemplateID | string | 模板ID |
示例
請求路徑://cdnapi-global.ctapi.daliqc.cn/live/notify-template/update-notify-template
請求JSON示例
{
"TemplateID": "65shhklue975easaa457",
"Params":{
"RecordNotifyUrl": "daliqc.cn",
"SnapshotNotifyUrl":"daliqc.cn1",
"IdentifyNotifyUrl": "daliqc.cn",
"CallbackReqAuth": "on",
"CallbackAuthKey": "test"
}
}
正常返回JSON示例
{
"code": 100000,
"message": "success",
"TemplateID": "65shhklue975easaa457"
}