文档

SendCommand - 发送指令消息

更新时间:

发送一个指令消息给到服务端,数字人执行对应的指令,并渲染视频流给到用户。目前指令仅支持打断指令。

调试

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

授权信息

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

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

请求参数

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

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

76898bd3b90b4a65b1c078d8824a2e9c
SessionIdstring

会话 SessionID。通过“启动一个数字人”API 的返回值获取。

5615
Codestring

指令 code:

  • INTERRUPT :打断当前数字人播报,让数字人停止说话,Content 无需传内容
  • CHANGE_BACKGROUND :切换背景,Content 需传背景图片 URL,具体参数见 Content 字段定义
INTERRUPT
Contentobject

指令内容,map 类型,不同的指令需要不同的参数内容,部分指令不需要指令内容的可以不传改参数。

CHANGE_BACKGROUND
{ "backGroundImageUrl":"http://xxxxx.png" }
{}
UniqueCodestring

消息请求唯一 code,最大支持 64 位,需要保持唯一,可使用 UUID。

0000001000586737
Feedbackboolean

是否需要在数字人进行执行该条消息的时候进行回调通知,默认值 false,具体可参考:数字人回调事件通知

注意 当前 INTERRUPT 指令暂不支持事件回调

false

返回参数

名称类型描述示例值
object

Schema of Response

RequestIdstring

Id of the request

0A466686-8F3A-55A6-93D8-A0225DC965C0
Codestring

返回处理异常对应 code

10010001
Messagestring

返回处理异常对应描述

operation success.
Successboolean

是否成功

true
Dataobject

返回结果

SessionIdstring

会话 SessionID

9929391f61ef9e1c0000000000000006
UniqueCodestring

消息请求唯一 code

0000001000586737

示例

正常返回示例

JSON格式

{
  "RequestId": "0A466686-8F3A-55A6-93D8-A0225DC965C0\n",
  "Code": "10010001",
  "Message": "operation success.\n",
  "Success": true,
  "Data": {
    "SessionId": "9929391f61ef9e1c0000000000000006\n",
    "UniqueCode": "0000001000586737\n"
  }
}

错误码

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

变更历史

变更时间变更内容概要操作
暂无变更历史
  • 本页导读 (0)