发送一段播报文本给到服务端,数字人会基于文本做TTS生成、表情动作驱动,并渲染视频流给到用户。
接口说明
二方包引入可参考API概览的信息
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
avatar:SendMessage | Write |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
SessionId | string | 否 | 会话 SessionID。通过“启动一个数字人”API的返回值获取。 | 76898bd3b90b4a65b1c078d8824a2e9c |
TenantId | long | 否 | 租户ID,从虚拟数字人开放平台中获取的TenantId | 5615 |
TextRequest | object | 否 | 播报文本 | |
CommandType | string | 否 | 命令类型
| 枚举值如下: START 表示开始播报一段文本 HOLDING 表示暂停当前播报 RESUME 表示恢复当前播报 |
SpeechText | string | 否 | 播报文本的内容,目前支持纯文本和阿里云智能语音合成的SSML标记语言(SSML使用方案请参考官方文档),最大文本长度1000字(不包含标签) | 纯文本:这是一段示例播报纯文本 SSML:SSML使用请参考官方文档 |
Id | string | 否 | 对应SpeechText文本的Id,最大支持64位,需要保持唯一,可使用UUID | 0000001000586737 |
interrupt | boolean | 否 | 播报时是否打断上一次播报内容,默认不打断 | false |
VAMLRequest | object | 否 | VAML协议请求对象 | |
Code | string | 否 | VAML请求类型:默认可以不填 | VAML_REQUEST |
Vaml | string | 否 | VAML协议请求,具体参考官方文档 | 参考文档 |
Feedback | boolean | 否 | 是否需要在数字人进行播报该条消息的时候进行回调通知,默认值false,具体可参考:数字人回调事件通知。 | false |
返回参数
示例
正常返回示例
JSON
格式
{
"Code": "QUERY_ACCOUNT_INFO_ERROR",
"Message": "operation success.",
"Data": {
"RequestId": "0A466686-8F3A-55A6-93D8-A0225DC965C0",
"SessionId": "9929391f61ef9e1c0000000000000006"
},
"Success": true
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||||
---|---|---|---|---|---|---|
2023-05-10 | OpenAPI 入参发生变更 | |||||
|