本产品（
虚拟数字人开放平台/2022-01-30）的OpenAPI采用RPC签名风格，签名细节参见签名机制说明。我们已经为开发者封装了常见编程语言的SDK，开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求，可通过签名机制进行自签名对接。由于自签名细节非常复杂，需花费 5个工作日左右。因此建议加入我们的服务钉钉群（11370001915），在专家指导下进行签名对接。在使用API前，您需要准备好身份账号及访问密钥（AccessKey），才能有效通过客户端工具（SDK、CLI等）访问API。细节请参见获取AccessKey。
数字人实例
| API | 标题 | API概述 |
|---|---|---|
| StartInstance | 启动一个数字人 | 启动一路数字人视频流实例，通过传入指定的参数，可以启动一路数字人实例，该接口针对播报数字人、互动数字人等这类使用平台默认视频流渠道的数字人实例会返回阿里公有云RTC拉流需要的参数，使用者无需额外开通阿里公有云RTC产品服务，可直接通过阿里云RTC拉流SDK配合该接口返回的Channel参数进行拉流使用。关于阿里公有云RTC拉流SDK接入文档可参考数字人开放平台帮助中心《客户端SDK接入》文档。 |
| StopInstance | 停止一个数字人 | 关闭一路数字人实例，停止数字人推流。 |
| QueryRunningInstance | 查询运行中的数字人实例 | 查询运行中的数字人实例列表，该接口仅返回运行中的实例，已关闭的实例不会返回，最多返回100条，按照时间倒序排列；同时支持查询指定sessionId的实例的运行状态，传入sessionId参数，如果该实例在运行中则会返回，不在运行中或者对应实例不存在，则不会返回信息。 |
消息
| API | 标题 | API概述 |
|---|---|---|
| SendMessage | 发送文本消息 | 发送一段播报文本给到服务端，数字人会基于文本做TTS生成、表情动作驱动，并渲染视频流给到用户。 |
数字人离线视频合成
| API | 标题 | API概述 |
|---|---|---|
| SubmitTextTo3DAvatarVideoTask | 提交3D文本视频合成任务 | 提交根据一段文本离线生成3D数字人视频任务，该接口会立即返回一个TaskUuid作为本次提交任务的唯一id，后续可以根据TaskUuid调用查询和取消任务接口。 |
| SubmitTextTo2DAvatarVideoTask | 提交2D文本视频合成任务 | 提交根据一段文本离线生成2D数字人视频任务，该接口会立即返回一个TaskUuid作为本次提交任务的唯一id，后续可以根据TaskUuid调用查询和取消任务接口。 |
| SubmitTextToSignVideoTask | 提交手语文本视频合成任务 | 提交根据一段文本离线生成手语视频合成任务，该接口会立即返回一个TaskUuid作为本次提交任务的唯一id，后续可以根据TaskUuid调用查询和取消任务接口。 |
| GetVideoTaskInfo | 查询视频合成任务详情 | 通过提交任务生成的TaskUuid，查询对应视频合成任务详情。同时支持3D数字人和2D数字人的视频合成任务详情查询。 |
| CancelVideoTask | 取消视频合成任务 | 通过提交任务生成的TaskUuid， 取消状态为”等待执行“的任务。 |
控制台管理
| API | 标题 | API概述 |
|---|---|---|
| StartTimedResetOperate | 停复机操作开机接口 | 停复机操作开机接口，提供对指定的数字人停复机实例（来自虚拟数字人开放平台——实例管理页面）进行开机操作，功能等同于点击页面的开机按钮。 |
| CloseTimedResetOperate | 停复机操作关机接口 | 停复机操作关机接口，提供对指定的数字人停复机实例（来自虚拟数字人开放平台——实例管理页面）进行关机操作，功能等同于点击页面的关机按钮。 |
| QueryTimedResetOperateStatus | 停复机实例开关机状态查询接口 | 查询停复机操作状态接口，提供查询指定的数字人停复机实例（来自虚拟数字人开放平台——实例管理页面）的开关机状态。 |
其他
| API | 标题 | API概述 |
|---|---|---|
| DuplexDecision | 语音双工决策 | 语音双工决策接口API。 |