首页 虚拟数字人开放平台 API参考指南 API目录 数字人实例 StartInstance - 启动一个数字人

StartInstance - 启动一个数字人

启动一路数字人视频流实例，通过传入指定的参数，可以启动一路数字人实例，该接口针对播报数字人、互动数字人等这类使用平台默认视频流渠道的数字人实例会返回阿里公有云RTC拉流需要的参数，使用者无需额外开通阿里公有云RTC产品服务，可直接通过阿里云RTC拉流SDK配合该接口返回的Channel参数进行拉流使用。关于阿里公有云RTC拉流SDK接入文档可参考数字人开放平台帮助中心《客户端SDK接入》文档。

接口说明

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

调试

您可以在OpenAPI Explorer中直接运行该接口，免去您计算签名的困扰。运行成功后，OpenAPI Explorer可以自动生成SDK代码示例。

调试

授权信息

下表是API对应的授权信息，可以在RAM权限策略语句的Action元素中使用，用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下：

  • 操作：是指具体的权限点。
  • 访问级别：是指每个操作的访问级别，取值为写入（Write）、读取（Read）或列出（List）。
  • 资源类型：是指操作中支持授权的资源类型。具体说明如下：
    • 对于必选的资源类型，用背景高亮的方式表示。
    • 对于不支持资源级授权的操作，用全部资源表示。
  • 条件关键字：是指云产品自身定义的条件关键字。
  • 关联操作：是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限，操作才能成功。
操作访问级别资源类型条件关键字关联操作
avatar:StartInstanceWrite
  • Avatar
    acs:avatar::{#accountId}:*
    无
无

请求参数

名称类型必填描述示例值
TenantIdlong否

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

9185
Appobject否

代表一个业务配置

AppIdstring否

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

ALIPUB5748B17121450
Userobject否

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

UserIdstring否

客户自身的用户ID，或者设备号等，如果没有可以直接传递一个随机数

23423
UserNamestring否

与UserId对应的用户名，可空

测试用户
Channelobject否

频道信息，针对使用播报数字人、互动数字人不传即可。针对推流数字人则需要传递对应的推流参数信息。

Typestring否

频道类型: RTMP: RTMP推流 MRTC: MRTC音视频通话

RTMP
ReqConfigobject否

频道请求协议体，map类型，

警告 此参数不传，默认使用平台提供的AliRTC音视频通话渠道。
  • RTMP:

{"url": "", "token": ""} - url: 直播平台RTMP推流地址。 - token： 直播平台RTMP密钥。

警告 针对部分直播平台只有一个服务器地址，可以将该地址作为url传入，token不传。
  • MRTC:

{ "bizName": "", "subBiz": "", "sign": "", "roomUrl": "", "userId": "", "roomToken": "", "roomId":xxx } - bizName: 业务类型，比如 Bank（银行类业务）、Stock（证券类业务）。 - subBiz: 子业务类型，比如上海银行，平安证券等。 - sign: 房间服务器需要验证该通话业务的合法性。 - roomUrl: 房间服务器的接入地址。 - userId: 用户 ID，唯一标识房间里的某个用户。 - roomToken: 加入房间的凭证。 - roomId: 创建的房间 ID，唯一标识。

说明详细MRTC使用可参考文档mpaas平台音视频通话LinuxSDK对应的JoinRoomParam
CommandRequestobject否

数字人命令执行请求

AlphaSwitchboolean否

是否是透明通道

true：透明通道 false：非透明通道

返回参数

名称类型描述示例值
object

Schema of Response

Codestring

返回结果码

0
Messagestring

返回信息

错误信息示例
Dataobject

返回结果

RequestIdstring

请求ID

4C467B38-3910-447D-87BC-AC049166F216
SessionIdstring

会话ID。标识这一路数字人实例的唯一id，后续发送播报文本、停止数字人实例都需要传入该ID，如果丢失可以通过“查询运行中的数字人实例”API进行查询。

4f63f9e9788449f9adc88d9438c8dec3
Channelobject

频道信息，目前返回互动和播报数字人平台默认视频流AliRTC渠道的频道信息，用于进行客户端拉流使用； 针对互动和推流数字人使用了三方推流通道的不会返回对应信息， 如RTMP推流和MRTC通话。

ChannelIdstring

频道ID

108293819
Tokenstring

AliRTC令牌码。

e59f61b2482b4d0562ab542da3f824f7
Typestring

通道类型

6
ExpiredTimestring

AliRTC通道到期时间

1677112265876
Noncestring

AliRTC服务器生成的随机字符串。

CK-9b5c335b9ae75879441ee7b363886418
UserIdstring

AliRTC生成的UserId

userId
AppIdstring

AliRTC应用id

ONEX7E28C7C221854
UserInfoInChannelstring

公有云音视频RTC需要的信息

公有云音视频RTC需要的信息
Gslbarray

AliRTC通道地址

string

AliRTC通道地址

https://rgslb.rtc.aliyuncs.com
Tokenstring

互动数字人对接需要的鉴权token ,具体可参考互动数字人接入文档

879441ee7b363886418
Successboolean

调用是否成功。

True

示例

正常返回示例

JSON格式

{
  "Code": "0",
  "Message": "错误信息示例",
  "Data": {
    "RequestId": "4C467B38-3910-447D-87BC-AC049166F216",
    "SessionId": "4f63f9e9788449f9adc88d9438c8dec3",
    "Channel": {
      "ChannelId": "108293819",
      "Token": "e59f61b2482b4d0562ab542da3f824f7",
      "Type": "6",
      "ExpiredTime": "1677112265876",
      "Nonce": "CK-9b5c335b9ae75879441ee7b363886418",
      "UserId": "userId",
      "AppId": "ONEX7E28C7C221854",
      "UserInfoInChannel": "公有云音视频RTC需要的信息",
      "Gslb": [
        "https://rgslb.rtc.aliyuncs.com"
      ]
    },
    "Token": "879441ee7b363886418"
  },
  "Success": true
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
2022-08-25OpenAPI 入参发生变更
变更项变更内容
入参OpenAPI 入参发生变更
    新增入参：CommandRequest
阿里云首页 虚拟数字人 相关技术圈