SubmitTextTo2DAvatarVideoTask_虚拟数字人开放平台_API文档

插件下载了解更多
VS Code 插件
安装插件之前,确保已安装 VS Code安装插件之前,确保已安装 VS Code
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
JetBrains 插件
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.

接口说明

提交根据一段文本离线生成 2D 数字人视频任务,该接口会立即返回一个 TaskUuid 作为本次提交任务的唯一 id,后续可以根据 TaskUuid 调用查询视频合成任务详情接口查询对应的任务的状态,当任务状态为已完成时可以获取到对应视频的下载地址,进行视频下载。在任务状态为未开始情况下,也可以通过 TaskUuid 调用取消视频合成任务接口,取消该任务。

说明 参考 2D 数字人视频合成使用指南了解完整的 2D 视频合成接入流程。

流控信息

当前云产品API请求速率暂未透出。

授权信息

如下是此API对应的授权信息,用于RAM权限策略语句的Action元素中,为RAM用户或RAM角色授予调用此API的权限。请通过 RAM 访问控制设置,使用方法可参考访问控制帮助文档

具体说明如下:展开详情

操作访问级别资源类型条件关键字关联操作
avatar:SubmitTextTo2DAvatarVideoTask
Create
全部资源
*

请求参数

字段名称字段详情
TenantIdinteger<int64>

租户 ID,从虚拟数字人开放平台中获取的 TenantId

注意 该字段类型为 Long,在序列化/反序列化的过程中可能导致精度丢失,请注意数值不得大于 9007199254740991。
示例值:xxxxx
Appobject

开发者应用信息,代表一个业务配置

Titlestring

提交的视频合成的任务标题,最长不超过 64 个字符

示例值:这是一个示例标题
Textstring

合成文本, 最长不超过 1000 个字符。支持 SSML 指定 TTS 的多音字发音、停顿、特殊读法等,可参考: 2D 数字人视频合成使用指南

示例值:这是一个示例文本参考取值来源:
    SendText
VideoInfoobject

视频配置

AudioInfoobject

音频相关配置,不传则使用资产中配置的默认值。

AvatarInfoobject

数字人形象相关配置。

Callbackboolean

本次视频合成任务是否需要事件回调,默认 false 不回调。平台支持在任务开始和任务结束时进行事件回调,具体可参考文档:数字人回调事件通知

示例值:false
CallbackParamsstring

回调时需要透传的一些参数,json 格式字符串,callback=false 时不生效。

示例值:{ "xxx": "xxx" }
ExtParamsstring

一些扩展参数。

示例值:{ "xxx": "xxx" }

返回参数

字段名称字段详情
RequestIdstring

请求 ID

示例值:13E0445E-CA7F-5DD3-9B0F-D4B39E0180F7
Successboolean

调用是否成功。

示例值:false
Codestring

错误码

示例值:-10000000
Messagestring

错误消息

示例值:这个一次错误消息。
Dataobject

调用结果数据

返回说明

TaskUuid 是该任务的唯一标识,请务必保存好。

返回示例

变更历史

变更时间变更内容概要操作
2024-01-08
变更请求参数VideoInfo
2024-01-08
变更请求参数AudioInfo
2023-12-14
变更请求参数AvatarInfo
2023-08-01
变更请求参数VideoInfo
变更返回参数
2023-06-25
新增请求参数Callback
新增请求参数CallbackParams
新增请求参数ExtParams
2023-06-07
变更请求参数VideoInfo
2023-05-12
变更请求参数VideoInfo
2022-11-30
变更返回参数
  • 1
  • 2
  • 10 条/页

相关示例