新增回調模板
更新時間 2023-11-09 14:59:39
最近更新時間: 2023-11-09 14:59:39
分享文章
接口功能介紹
支持錄制、截圖和審核等功能的回調。
使用說明
此接口需與“綁定/解綁回調模板”接口搭配使用，才可實現進行域名的回調配置
接口詳情
請求方式：POST
請求路徑：/live/notify-template/create-notify-template
請求JSON參數
| 代碼 | 類型 | 字段名稱 | 是否必須 | 說明 |
|---|---|---|---|---|
| TemplateName | string | 模板名稱 | 是 | 1至10個大小寫英文字符、數字及“-“符號 |
| Description | string | 模板描述 | 否 | 1至255 個字符 |
| Params | dict | 模板參數 | 是 | 見下文說明 |
回調模板參數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/create-notify-template
請求JSON示例
{
"TemplateName":"tes11t11",
"Params":{
"RecordNotifyUrl": "daliqc.cn",
"SnapshotNotifyUrl":"daliqc.cn1",
"IdentifyNotifyUrl":"daliqc.cn2",
"CallbackReqAuth": "on",
"CallbackAuthKey": "test"
}
}
正常返回JSON示例
{
"code": 100000,
"message": "success",
"TemplateID": "65shhklue975easaa457"
}
