接口功能介绍
支持录制、截图和审核等功能的回调。
使用说明
此接口需与“绑定/解绑回调模板”接口搭配使用,才可实现进行域名的回调配置
接口详情
请求方式: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 |
示例
请求路径:https://cdnapi-global.ctapi.ctyun.cn/live/notify-template/create-notify-template
请求JSON示例
{
"TemplateName":"tes11t11",
"Params":{
"RecordNotifyUrl": "ctyun.cn",
"SnapshotNotifyUrl":"ctyun.cn1",
"IdentifyNotifyUrl":"ctyun.cn2",
"CallbackReqAuth": "on",
"CallbackAuthKey": "test"
}
}
正常返回JSON示例
{
"code": 100000,
"message": "success",
"TemplateID": "65shhklue975easaa457"
}