1. 接口描述
接口请求域名: mps.tencentcloudapi.com 。
修改用户自定义智能字幕模板。
默认接口请求频率限制:20次/秒。
推荐使用 API Explorer
点击调试
API Explorer 提供了在线调用、签名验证、SDK 代码生成和快速检索接口等能力。您可查看每次调用的请求内容和返回结果以及自动生成 SDK 调用示例。
2. 输入参数
以下请求参数列表仅列出了接口请求参数和部分公共参数,完整公共参数列表见 公共请求参数。
参数名称 | 必选 | 类型 | 描述 |
---|---|---|---|
Action | 是 | String | 公共参数,本接口取值:ModifySmartSubtitleTemplate。 |
Version | 是 | String | 公共参数,本接口取值:2019-06-12。 |
Region | 否 | String | 公共参数,本接口不需要传递此参数。 |
Definition | 是 | Integer | 智能字幕模板唯一标识 示例值:30 |
TranslateSwitch | 否 | String | 字幕翻译开关 ON: 开启翻译 OFF: 关闭翻译 示例值:ON |
Name | 否 | String | 智能字幕模板名称 长度限制:64 个字符。 示例值:智能字幕模板 |
Comment | 否 | String | 智能字幕模板描述信息 长度限制:256 个字符。 示例值:模板2 |
VideoSrcLanguage | 否 | String | 智能字幕视频源语言 当前支持以下语言: zh:简体中文 en:英语 ja:日语 ko:韩语 zh-PY:中英粤 zh-medical:中文医疗 yue:中文粤语 vi:越南语 ms:马来语 id:印度尼西亚语 fil:菲律宾语 th:泰语 pt:葡萄牙语 tr:土耳其语 ar:阿拉伯语 es:西班牙语 hi:印地语 fr:法语 de:德语 zh_dialect:中文方言 示例值:zh |
SubtitleFormat | 否 | String | 智能字幕文件格式 vtt: WebVTT 格式 不填或填空:不生成字幕文件 示例值:vtt |
SubtitleType | 否 | Integer | 智能字幕字幕语言类型 0: 源语言 1: 翻译语言 2: 源语言+翻译语言 当TranslateSwitch为OFF时仅支持取0 当TranslateSwitch为ON时仅支持取1或2 示例值:0 |
AsrHotWordsConfigure | 否 | AsrHotWordsConfigure | ASR热词库参数 |
TranslateDstLanguage | 否 | String | 字幕翻译目标语言 当TranslateSwitch为ON的时候生效 当前支持以下语言: zh:简体中文 en:英语 ja:日语 ko:韩语 fr:法语 es:西班牙语 it:意大利语 de:德语 tr:土耳其语 ru:俄语 pt:葡萄牙语 vi:越南语 id:印度尼西亚语 ms:马来语 th:泰语 ar:阿拉伯语 hi:印地语 示例值:en |
3. 输出参数
参数名称 | 类型 | 描述 |
---|---|---|
RequestId | String | 唯一请求 ID,由服务端生成,每次请求都会返回(若请求因其他原因未能抵达服务端,则该次请求不会获得 RequestId)。定位问题时需要提供该次请求的 RequestId。 |
4. 示例
示例1 修改智能字幕模板
输入示例
POST / HTTP/1.1
Host: mps.tencentcloudapi.com
Content-Type: application/json
X-TC-Action: ModifySmartSubtitleTemplate
<公共请求参数>
{
"Definition": 202281,
"TranslateSwitch": "ON",
"Name": "新名字",
"SubtitleType": 1,
"TranslateDstLanguage": "en"
}
输出示例
{
"Response": {
"RequestId": "569d5d19-d01c-4efc-97dc-4ea53ae95647"
}
}
5. 开发者资源
腾讯云 API 平台
腾讯云 API 平台 是综合 API 文档、错误码、API Explorer 及 SDK 等资源的统一查询平台,方便您从同一入口查询及使用腾讯云提供的所有 API 服务。
API Inspector
用户可通过 API Inspector 查看控制台每一步操作关联的 API 调用情况,并自动生成各语言版本的 API 代码,也可前往 API Explorer 进行在线调试。
SDK
云 API 3.0 提供了配套的开发工具集(SDK),支持多种编程语言,能更方便的调用 API。
- Tencent Cloud SDK 3.0 for Python: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Java: GitHub, Gitee
- Tencent Cloud SDK 3.0 for PHP: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Go: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Node.js: GitHub, Gitee
- Tencent Cloud SDK 3.0 for .NET: GitHub, Gitee
- Tencent Cloud SDK 3.0 for C++: GitHub, Gitee
- Tencent Cloud SDK 3.0 for Ruby: GitHub, Gitee
命令行工具
6. 错误码
以下仅列出了接口业务逻辑相关的错误码,其他错误码详见 公共错误码。
错误码 | 描述 |
---|---|
FailedOperation.InvalidMpsUser | 操作失败:非法 mps 用户。 |
InternalError | 内部错误。 |
InvalidParameter | 参数错误。 |
InvalidParameterValue.AsrHotWordsLibraryId | 参数值错误:热词库ID |
InvalidParameterValue.AsrHotWordsSwitch | 参数值错误:热词库开关 |
InvalidParameterValue.Comment | 参数错误:对该模板的描述。 |
InvalidParameterValue.ModifyDefaultTemplate | 参数值错误:不允许修改默认模板。 |
InvalidParameterValue.Name | 参数值错误:Name 超过长度限制。 |
InvalidParameterValue.SubtitleFormat | 参数值错误:SubtitleFormat 参数非法。 |
InvalidParameterValue.SubtitleType | 参数值错误:字幕语言类型 |
InvalidParameterValue.TranslateDstLanguage | 参数值错误:翻译目标语言 |
InvalidParameterValue.TranslateSwitch | 参数值错误:翻译开关 |
InvalidParameterValue.VideoSrcLanguage | 参数值错误:视频源语言错误 |
ResourceNotFound.TemplateNotExist | 资源不存在:模板不存在。 |