DescribeRtcRobotInstance - 查询RTC互动AI智能体实例

查询一个RTC互动AI智能体实例的信息

调试

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

授权信息

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

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

请求参数

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

实例 ID

727dc0e296014bb58670940a3da95592

返回参数

名称类型描述示例值
object

Schema of Response

AuthTokenstring

RTC 的入会凭证

**********
ChannelIdstring

频道 ID

testId
Configobject

AI 智能体高级配置

EnableVoiceInterruptboolean

是否允许语音打断

true
Greetingstring

欢迎语

你好
VoiceIdstring

音色 ID

zhixiaoxia
RequestIdstring

请求 ID。

20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91
Statusstring

实例状态:

  • Executing 运行中

  • Finished 结束

Executing
UserDatastring

用户自定义信息

{}
UserIdstring

AI 智能体在频道中的 ID

my-robot

示例

正常返回示例

JSON格式

{
  "AuthToken": "**********",
  "ChannelId": "testId",
  "Config": {
    "EnableVoiceInterrupt": true,
    "Greeting": "你好",
    "VoiceId": "zhixiaoxia"
  },
  "RequestId": "20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91",
  "Status": "Executing",
  "UserData": "{}",
  "UserId": "my-robot"
}

错误码

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