DescribeRtcRobotInstance - Intelligent Media Services - Alibaba Cloud Documentation Center

Try it now

Try this API in OpenAPI Explorer, no manual signing needed. Successful calls auto-generate SDK code matching your parameters. Download it with built-in credential security for local usage.

Test

RAM authorization

The table below describes the authorization required to call this API. You can define it in a Resource Access Management (RAM) policy. The table's columns are detailed below:

Action: The actions can be used in the Action element of RAM permission policy statements to grant permissions to perform the operation.
API: The API that you can call to perform the action.
Access level: The predefined level of access granted for each API. Valid values: create, list, get, update, and delete.
Resource type: The type of the resource that supports authorization to perform the action. It indicates if the action supports resource-level permission. The specified resource must be compatible with the action. Otherwise, the policy will be ineffective.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the Resource element of the policy.
- For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the Resource element of the policy.
Condition key: The condition keys defined by the service. The key allows for granular control, applying to either actions alone or actions associated with specific resources. In addition to service-specific condition keys, Alibaba Cloud provides a set of common condition keys applicable across all RAM-supported services.
Dependent action: The dependent actions required to run the action. To complete the action, the RAM user or the RAM role must have the permissions to perform all dependent actions.

Action

Access level

Resource type

Condition key

Dependent action

ice:DescribeRtcRobotInstance

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
InstanceId	string	No	The instance ID.	727dc0e296014bb58670940a3da95592

Response elements

Element	Type	Description	Example
	object	The response body.
AuthToken	string	The authentication token for the RTC Channel.	**********
ChannelId	string	The channel ID.	testId
Config	object	The advanced configurations of the AI agent.
EnableVoiceInterrupt	boolean	Specifies whether to allow voice interruption.	true
Greeting	string	The welcome message.	Hello
VoiceId	string	The voice ID.	zhixiaoxia
RequestId	string	The request ID.	20B3A1B6-4BD2-5DE6-BCBC-098C9B4F4E91
Status	string	The status of the instance. Valid values: `Executing`: The instance is running. `Finished`: The instance has stopped.	Executing
UserData	string	The custom user data.	{}
UserId	string	The ID of the AI agent in the channel.	my-robot

Examples

Success response

JSON format

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

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.