StartInstance
启动一路数字人视频流实例，通过传入指定的参数，可以启动一路数字人实例，该接口针对播报数字人、互动数字人等这类使用平台默认视频流渠道的数字人实例会返回阿里公有云RTC拉流需要的参数，使用者无需额外开通阿里公有云RTC产品服务，可直接通过阿里云RTC拉流SDK配合该接口返回的Channel参数进行拉流使用。关于阿里公有云RTC拉流SDK接入文档可参考数字人开放平台帮助中心《客户端SDK接入》文档
服务地址：
华北3（张家口）
输入参数
只看必填
TenantId租户ID
App代表一个业务配置
AppIdAppId
User启动该数字人的用户信息（客户自身的用户信息
UserId客户自身的用户ID
UserName与UserId对应的用户名
Channel频道信息
Type频道类型：
ReqConfig频道请求协议体
CommandRequest数字人命令执行请求
AlphaSwitch是否需要透明
请选择布尔值
BackGroundImageUrl有效可访问的url背景图片地址
Locate数字人机位
BizId业务请求id
TextRequest播报内容相关的设置参数
PitchRateTTS播报声音语调
SpeechRateTTS播报声音语速
VoiceTTS播报发音人code
VolumeTTS播报声音音量
插件下载了解更多
VS Code 插件
安装插件之前，确保已安装 VS Code安装插件之前，确保已安装 VS Code
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
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
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
安 装

接口说明

二方包引入可参考 API 概览的信息。

请求参数

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

租户 ID，从虚拟数字人开放平台的对应业务配置的开发者信息中获取的 TenantId

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

代表一个业务配置

Userobject

启动该数字人的用户信息（客户自身的用户信息，或者设备号等，如果没有可以直接传递随机数）

Channelobject

频道信息，将数字人流媒体推送到指定渠道。目前支持标准 RTMP 协议。展开详情

CommandRequestobject

数字人命令执行请求

BizIdstring

业务请求 id，最大支持 64 位字符

注意 可以使用该字段做业务启动数字人的幂等，服务端确保同一个 bizId 多次调用只会开启一路实例

示例值:xxxxxxx
TextRequestobject

播报内容相关的设置参数

返回参数

字段名称字段详情
Codestring

返回结果码

示例值:0
Messagestring

返回信息

示例值:错误信息示例
Dataobject

返回结果

Successboolean

调用是否成功。

示例值:True
变更历史
变更时间变更内容概要操作
2024-01-24
变更请求参数CommandRequest
新增请求参数TextRequest
2023-11-08
新增请求参数BizId
2022-08-25
新增请求参数CommandRequest
2022-08-05
变更返回参数
2022-03-01
新增OpenAPI，启动一个数字人