DescribeRtcRobotInstance - 查询RTC互动AI智能体实例_智能媒体服务(IMS)-阿里云帮助中心

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

调试

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

授权信息

当前API暂无授权信息透出。

请求参数

名称	类型	必填	描述	示例值
InstanceId	string	否	实例 ID	727dc0e296014bb58670940a3da95592

返回参数

名称	类型	描述	示例值
	object	Schema of Response
RequestId	string	Id of the request	20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91
ChannelId	string	频道 ID	testId
UserId	string	AI 智能体在频道中的 ID	my-robot
Status	string	实例状态： ● Executing 运行中 ● Finished 结束	Executing
AuthToken	string	RTC 的入会凭证	**********
UserData	string	用户自定义信息	{}
Config	object	AI 智能体高级配置
VoiceId	string	音色 ID	zhixiaoxia
Greeting	string	欢迎语	你好
EnableVoiceInterrupt	boolean	是否允许语音打断	true

示例

正常返回示例

JSON格式

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

错误码

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