API 文档

创建回调模板

最近更新时间:2021-08-10 08:08:11

我的收藏

1. 接口描述

接口请求域名: live.tencentcloudapi.com 。

创建回调模板,成功返回模板id后,需要调用CreateLiveCallbackRule接口将模板 ID 绑定到域名/路径使用。

回调协议相关文档:事件消息通知
注意:至少填写一个回调 URL。

默认接口请求频率限制:200次/秒。

推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。

2. 输入参数

以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateLiveCallbackTemplate。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
TemplateName String 模板名称。
长度上限:255字节。
仅支持中文、英文、数字、_、-。
Description String 描述信息。
长度上限:1024字节。
仅支持中文、英文、数字、_、-。
StreamBeginNotifyUrl String 开播回调 URL,
相关协议文档:事件消息通知
StreamEndNotifyUrl String 断流回调 URL,
相关协议文档:事件消息通知
RecordNotifyUrl String 录制回调 URL,
相关协议文档:事件消息通知
SnapshotNotifyUrl String 截图回调 URL,
相关协议文档:事件消息通知
PornCensorshipNotifyUrl String 鉴黄回调 URL,
相关协议文档:事件消息通知
CallbackKey String 回调 Key,回调 URL 公用,回调签名详见事件消息通知文档。
事件消息通知
StreamMixNotifyUrl String 参数已弃用。

3. 输出参数

参数名称 类型 描述
TemplateId Integer 模板ID。
RequestId String 唯一请求 ID,每次请求都会返回。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 请求示例

输入示例

https://live.tencentcloudapi.com/?Action=CreateLiveCallbackTemplate
&TemplateName=testName
&Description=test
&CallbackKey=adasda131312
&StreamBeginNotifyUrl=http://www.yourdomain.com/api/notify?action=streamBegin
&StreamEndNotifyUrl=http://www.yourdomain.com/api/notify?action=streamEnd
&RecordNotifyUrl=http://www.yourdomain.com/api/notify?action=record
&SnapshotNotifyUrl=http://www.yourdomain.com/api/notify?action=snapshot
&PornCensorshipNotifyUrl=http://www.yourdomain.com/api/notify?action=porn
&<公共请求参数>

输出示例

{
"Response": {
  "TemplateId": 1000,
  "RequestId": "3c140219-cfe9-470e-b241-907877d6fb03"
}
}

5. 开发者资源

腾讯云 API 平台

腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。

API Inspector

用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。

SDK

云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。

命令行工具

6. 错误码

以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码

错误码 描述
FailedOperation.ConfInUsed 模版使用中。
FailedOperation.NotFound 找不到记录。
InternalError 内部错误。
InternalError.ArgsNotMatch 针对添加转码模版的接口。
InternalError.ConfInUsed 模版使用中。
InternalError.ConfNotFound 模版不存在。
InternalError.ConfOutLimit 模版数量超过显示。
InternalError.InvalidInput 参数检校不通过。
InternalError.NotFound 记录不存在。
InternalError.RuleAlreadyExist 规则已经配置。
InternalError.RuleInUsing 规则使用中。
InternalError.RuleNotFound 规则不存在。
InvalidParameter 参数错误。
InvalidParameter.ArgsNotMatch 错误的模板名。
InvalidParameter.COSCustomFileNameError Cos自定义文件名错误。
InvalidParameter.InvalidVodFileName 错误的VodFileName。
InvalidParameter.UrlNotSafe 域名解析不正确。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
UnsupportedOperation.NotLVBCodeMode 非直播码/新版控制台模式。
目录