Modify the scenario version.
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.
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
Actionelement 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
Resourceelement of the policy. - For APIs without resource-level permissions, it is shown as All Resources. Use an asterisk (*) in the
Resourceelement of the policy.
- For APIs with resource-level permissions, required resource types are marked with an asterisk (*). Specify the corresponding Alibaba Cloud Resource Name (ARN) in the
- 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 |
|---|---|---|---|---|
bailianvoicebot:UpdateApplicationVersion | update | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| BusinessUnitId | string | Yes | The ID of the Model Studio workspace. | llm-c11iig67g863rih8 |
| ApplicationId | string | Yes | The ID of the application. | a395011f-a247-400f-bc69-28796749fd52 |
| VersionId | string | Yes | The ID of the version. | 20904943-f711-494f-9f1f-e7f340f37707 |
| TranscriberConfig | object | No | The Automatic Speech Recognition (ASR) configuration. | |
| NlsAccessType | string | No | The ASR invocation method. | MANAGED |
| NlsEngine | string | No | The ASR engine. | ALIYUN |
| NlsAccessProfile | object | No | ||
| AccessProfileId | string | No | ||
| VocabularyId | string | No | ||
| EndSilenceTimeout | integer | No | ||
| CustomizationId | string | No | ||
| SpeechNoiseThreshold | integer | No | ||
| Model | string | No | ||
| CorrectionRules | array<object> | No | ||
object | No | |||
| Pattern | string | No | ||
| Replacement | string | No | ||
| SynthesizerConfig | object | No | The Text-to-Speech (TTS) configuration. | |
| NlsAccessType | string | No | The TTS invocation method. | MANAGED |
| NlsEngine | string | No | The TTS engine. | ALIYUN |
| Voice | string | No | The voice for speech synthesis. | aixia |
| SpeechRate | integer | No | The speech rate. | 3 |
| Volume | integer | No | The volume. | 50 |
| PitchRate | integer | No | The pitch. | 1 |
| NlsAccessProfile | object | No | ||
| AccessProfileId | string | No | ||
| Model | string | No | ||
| PronRules | array<object> | No | ||
object | No | |||
| Pattern | string | No | ||
| Replacement | string | No | ||
| ScriptProfile | object | Yes | The model configuration. | |
| Model | string | No | The large language model (LLM) to use. | qwen-plus |
| AgentProfile | object | No | The agent configuration. | |
| ScriptProfileTemplateId | string | No | The ID of the profile template. | SFM_PROMPTS_DEFAULT |
| PromptsJson | string | No | The configuration for the agent's prompts. | {"prompts":"I am a chatbot."} |
| Name | string | No | The name of the agent. | Voice bot |
| Description | string | No | The description of the agent. | Voice bot |
| InteractionConfig | object | No | The interaction configuration. | |
| SilenceDetectionConfig | object | No | The silence detection configuration. | |
| Timeout | integer | No | The timeout, in milliseconds. | 5000 |
| RagConfig | object | No | The Retrieval-Augmented Generation (RAG) configuration. | |
| RagEngine | string | No | The RAG engine. | BAILIAN |
| Enabled | boolean | No | Specifies whether to enable RAG. | false |
| KnowledgeBaseIds | array | No | The IDs of the knowledge bases. | |
string | No | The ID of the knowledge base. | 3678xghryt | |
| TopN | integer | No | The number of top search results to retrieve from the knowledge base. | 5 |
| MaxContentLength | integer | No | The maximum character length of the content retrieved by RAG. | 2000 |
| ToolConfig | object | No | The tool configuration. | |
| McpServers | array<object> | No | The MCP server configurations. | |
object | No | |||
| Name | string | No | The name of the MCP server. | phone-ai-call |
| BaseUrl | string | No | The base URL of the MCP server. | |
| SseEndpoint | string | No | The endpoint path for Server-Sent Events (SSE). | /phone-ai-call/mcp/sse?key=value |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | |||
| Code | string | The response code. | OK |
| HttpStatusCode | integer | The HTTP status code. | 200 |
| Message | string | The response message. | successful |
| RequestId | string | The request ID. | CF6D3484-19A1-5C77-863B-AC8B5754D37C |
| Data | string | The returned data. | 82ea16d1-425c-4c03-9be5-cc91de9779ed |
Examples
Success response
JSON format
Error codes
HTTP status code | Error code | Error message | Description |
|---|---|---|---|
| 400 | Parameter.Enumeration | The parameter %s must be one of the value of enumeration %s. | |
| 400 | Parameter.Blank | The parameter %s must not be null or empty. | |
| 400 | Parameter.Empty | The parameter %s may not be null or empty. | |
| 400 | Parameter.Null | The parameter %s may not be null. | |
| 403 | Permission.Unauthorized | You are not authorized to perform this action. %s privileges are required. | |
| 404 | NotExists.InstanceId | The specified instance %s does not exist. |