有奖捉虫:云通信与企业服务文档专题,速来> HOT

1. 接口描述

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

修改截图模板配置。

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

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

2. 输入参数

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

参数名称 必选 类型 描述
Action String 公共参数,本接口取值:ModifyLiveSnapshotTemplate。
Version String 公共参数,本接口取值:2018-08-01。
Region String 公共参数,本接口不需要传递此参数。
TemplateId Integer 模板 ID。
示例值:1000
CosAppId Integer Cos 应用 ID。
注:此参数现在须必选。
示例值:123
CosBucket String Cos Bucket名称。
注:CosBucket参数值不能包含-[appid] 部分。
注:此参数现在须必选。
示例值:bucket
CosRegion String Cos 地域。
注:此参数现在须必选。
示例值:beijing
TemplateName String 模板名称。
长度上限:255字节。
示例值:testName
Description String 描述信息。
长度上限:1024字节。
示例值:testDesc
SnapshotInterval Integer 截图间隔,单位s,默认10s。
范围: 5s ~ 300s。
示例值:10
Width Integer 截图宽度。默认:0(原始宽)。
示例值:250
Height Integer 截图高度。默认:0(原始高)。
示例值:250
PornFlag Integer 是否开启鉴黄,默认 0 。
0:不开启。
1:开启。
示例值:0
CosPrefix String Cos Bucket文件夹前缀。
示例值:12
CosFileName String Cos 文件名称。
示例值:12

3. 输出参数

参数名称 类型 描述
RequestId String 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。

4. 示例

示例1 ModifyLiveSnapshotTemplate

更新截图鉴黄模板配置。

输入示例

{
  "TemplateId": 0,
  "TemplateName": "xx",
  "Description": "xx",
  "SnapshotInterval": 0,
  "Width": 0,
  "Height": 0,
  "PornFlag": 0,
  "CosAppId": 0,
  "CosBucket": "xx",
  "CosRegion": "xx",
  "CosPrefix": "xx",
  "CosFileName": "xx"
}

输出示例

{
    "Response": {
        "RequestId": "xx"
    }
}

5. 开发者资源

腾讯云 API 平台

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

API Inspector

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

SDK

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

命令行工具

6. 错误码

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

错误码 描述
FailedOperation.CallOtherSvrFailed 调用内部服务失败。
FailedOperation.CosBucketNotExist Cos bucket 不存在。
FailedOperation.CosBucketNotPermission 无权限访问 Cos bucket。
FailedOperation.CosRoleNotExists Cos 角色不存在,请前往 控制台 -> 功能配置 -> 直播截图&鉴黄 页面进行授权。
FailedOperation.NotFound 找不到记录。
InternalError 内部错误。
InternalError.ArgsNotMatch 针对添加转码模版的接口。
InternalError.ConfInUsed 模版使用中。
InternalError.ConfNotFound 模版不存在。
InternalError.InvalidInput 参数检校不通过。
InternalError.NotFound 记录不存在。
InternalError.RuleAlreadyExist 规则已经配置。
InternalError.RuleInUsing 规则使用中。
InternalError.RuleNotFound 规则不存在。
InvalidParameter 参数错误。
InvalidParameter.COSCustomFileNameError Cos自定义文件名错误。
InvalidParameterValue 参数取值错误。
MissingParameter 缺少参数错误。
ResourceNotFound.ForbidService 用户被禁用。
ResourceNotFound.FreezeService 用户服务被冻结。
ResourceNotFound.StopService 账号停服,请先冲正开通服务后再操作。
ResourceNotFound.UserDisableService 用户主动停服。
UnsupportedOperation.NotLVBCodeMode 非直播码/新版控制台模式。