创建回调模板

最近更新时间:2019-05-09 19:25:45

1. 接口描述

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

创建回调模板,成功返回模板id后,需要调用CreateLiveCallbackRule接口将模板id绑定到域名/路径使用。
回调协议相关文档:事件消息通知

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:CreateLiveCallbackTemplate
Version String 公共参数,本接口取值:2018-08-01
Region String 公共参数,本接口不需要传递此参数。
TemplateName String 模板名称。非空的字符串
Description String 描述信息。
StreamBeginNotifyUrl String 开播回调URL,
相关协议文档:事件消息通知
StreamEndNotifyUrl String 断流回调URL,
相关协议文档:事件消息通知
RecordNotifyUrl String 录制回调URL,
相关协议文档:事件消息通知
SnapshotNotifyUrl String 截图回调URL,
相关协议文档:事件消息通知
PornCensorshipNotifyUrl String 鉴黄回调URL,
相关协议文档:事件消息通知
CallbackKey String 回调key,回调URL公用,鉴权回调说明详见回调格式文档

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.qq.com/api/notify?action=streamBegin
&StreamEndNotifyUrl=http://www.qq.com/api/notify?action=streamEnd
&StreamMixNotifyUrl=http://www.qq.com/api/notify?action=streamMix
&RecordNotifyUrl=http://www.qq.com/api/notify?action=record
&SnapshotNotifyUrl=http://www.qq.com/api/notify?action=snapshot
&PornCensorshipNotifyUrl=http://www.qq.com/api/notify?action=porn
&<公共请求参数>

输出示例

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

5. 开发者资源

API Explorer

该工具提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力,能显著降低使用云 API 的难度,推荐使用。

SDK

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

命令行工具

6. 错误码

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

错误码 描述
InternalError 内部错误
InvalidParameter 参数错误
InvalidParameterValue 参数取值错误
MissingParameter 缺少参数错误