接口功能介绍
支持直播录制、直播截图和直播审核等功能的回调模板的更新。
使用说明
(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 |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/live/notify-template/update-notify-template
请求JSON示例
{
"TemplateID": "65shhklue975easaa457",
"Params":{
"RecordNotifyUrl": "ctyun.cn",
"SnapshotNotifyUrl":"ctyun.cn1",
"IdentifyNotifyUrl": "ctyun.cn",
"CallbackReqAuth": "on",
"CallbackAuthKey": "test"
}
}
正常返回JSON示例
{
"code": 100000,
"message": "success",
"TemplateID": "65shhklue975easaa457"
}