接口说明
该接口是针对有定制化视频合成样式的需求使用,正常的视频合成任务请直接使用:提交 3D 文本合成视频任务、提交 3D 语音合成视频任务、提交 2D 文本合成视频任务、提交 2D 语音合成视频任务即可。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
avatar:SubmitToAvatarVideoTask | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
TenantId | long | 是 | 租户 ID,从虚拟数字人开放平台中获取的 TenantId | xxx |
App | object | 是 | App 信息,代表一个业务配置 | |
AppId | string | 是 | App ID。在开发者中心-实例管理页面获取对应的 appId,参考文档。 | 3d95xx946a |
Title | string | 是 | 提交的视频合成的任务标题 | 这是一个示例标题 |
VideoParams | string | 是 | 合成的视频需要的相关参数 | { "text": "测试", "characterCode": "CH_xxxxxx" } |
Callback | boolean | 否 | 本次视频合成任务是否需要事件回调,默认 false 不回调。平台支持在任务开始和任务结束时进行事件回调,具体可参考文档:数字人回调事件通知。 | false |
CallbackParams | string | 否 | 回调时需要透传的一些参数,json 格式字符串,callback=false 时不生效。 | { "xxx": "xxx" } |
ExtParams | string | 否 | 一些扩展参数。 | { "xxx": "xxx" } |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7\n",
"Success": true,
"Code": "10050008\n",
"Message": "这个一个错误消息。\n",
"Data": {
"TaskUuid": "xxxxxx-xxxxx-xxxxx"
}
}
错误码
访问错误中心查看更多错误码。