StartRtcRobotInstance - Intelligent Media Services - Alibaba Cloud Documentation Center

Starts a Real-time Conversational AI agent instance and joins an RTC call.

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:StartRtcRobotInstance

none

*All Resource

*

None

Request parameters

Parameter	Type	Required	Description	Example
RobotId	string	Yes	The AI agent ID.	ca28b08ad3464ebcb42e5c0f7c6d2e89
ChannelId	string	Yes	The RTC channel ID.	testId
UserId	string	Yes	The ID of the AI agent in the channel.	my-robot
UserData	string	No	The custom user information.	{}
AuthToken	string	Yes	The RTC join token. You must generate this token by using the RTC AppKey.	**********
Config	object	No	The advanced call configuration. If specified, this configuration overwrites the default configurations that were set when the AI agent was created. If not specified, the default configurations are used.
AsrMaxSilence	integer	No
EnableVoiceInterrupt	boolean	No	Specifies whether voice interruption is allowed.	true
Greeting	string	No	The greeting message that the AI agent proactively speaks after the user joins the call.	Hello, how can I help you?
UseVoiceprint	boolean	No
UserOfflineTimeout	integer	No
UserOnlineTimeout	integer	No
VoiceId	string	No	The voice ID.	zhixiaoxia
VoiceprintId	string	No
Volume	integer	No

Response elements

Element	Type	Description	Example
	object	Schema of Response
InstanceId	string	The instance ID.	727dc0e296014bb58670940a3da95592
RequestId	string	Id of the request	11DE0AB3-603B-5055-8A72-9C424854F983

Examples

Success response

JSON format

{
  "InstanceId": "727dc0e296014bb58670940a3da95592",
  "RequestId": "11DE0AB3-603B-5055-8A72-9C424854F983"
}

Error codes

See Error Codes for a complete list.

Release notes

See Release Notes for a complete list.