Create a voicebot application 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:CreateApplicationVersion | create | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| BusinessUnitId | string | Yes | The Model Studio workspace ID. | llm-c11iig67g863rih8 |
| ApplicationId | string | Yes | The application ID. | a395011f-a247-400f-bc69-28796749fd52 |
| SourceVersionId | string | No | The ID of the source version to be published. | 20904943-f711-494f-9f1f-e7f340f37707 |
| TranscriberConfig | object | No | The Automatic Speech Recognition (ASR) configuration. | |
| NlsAccessType | string | No | The ASR access method. | MANAGED |
| NlsEngine | string | No | The ASR engine type. | ALIYUN |
| NlsAccessProfile | object | No | Configuration for a third-party ASR service. | |
| AccessProfileId | string | No | The ID of the third-party voice configuration. This is required when using a third-party ASR service, such as Doubao or iFLYTEK. | c2c9baae-9351-4c49-a8cb-6f24a83a8718 |
| VocabularyId | string | No | The ID of the custom | cd97223f-42f2-4cd9-95af-e734e2fe1fe3 |
| EndSilenceTimeout | integer | No | The timeout for voice activity detection (VAD), in milliseconds. The recognizer ends the utterance if a period of silence exceeds this value. | 700 |
| CustomizationId | string | No | The custom language model ID for ASR. | cd97223f-42f2-4cd9-95af-e734e2fe1fe4 |
| SpeechNoiseThreshold | integer | No | The noise threshold. Valid values: [-100, 100]. The closer the value is to -100, the more likely the system treats noise as speech. The closer the value is to +100, the more likely the system treats speech as noise. | 0 |
| Model | string | No | The ASR model. Valid values:
| fun-asr-flash-8k-realtime |
| CorrectionRules | array<object> | No | A list of rules to automatically correct transcription results by replacing specific text patterns. | |
object | No | |||
| Pattern | string | No | The text to match. | |
| Replacement | string | No | The replacement text. | |
| SynthesizerConfig | object | No | The Text-to-Speech (TTS) configuration. | |
| NlsAccessType | string | No | The TTS access method. | MANAGED |
| NlsEngine | string | No | The TTS engine type. | ALIYUN |
| Voice | string | No | The | aiqi |
| SpeechRate | integer | No | The speech rate. Valid values: -500 to 500. | -156 |
| Volume | integer | No | The | 50 |
| PitchRate | integer | No | The speech pitch. Valid values: -500 to 500. | 50 |
| NlsAccessProfile | object | No | Configuration for accessing external TTS services. | |
| AccessProfileId | string | No | The ID of the access profile for the external TTS service. | |
| Model | string | No | The TTS model. | |
| PronRules | array<object> | No | A list of rules to define custom pronunciations for specific text patterns. | |
object | No | |||
| Pattern | string | No | The text to match. | |
| Replacement | string | No | The replacement text. | |
| ScriptProfile | object | No | Configuration for the Large Language Model (LLM) and | |
| Model | string | No | The LLM model ID. | qwen-plus |
| AgentProfile | object | No | The agent configuration. | |
| ScriptProfileTemplateId | string | No | The agent configuration template ID. | SFM_PROMPTS_DEFAULT |
| PromptsJson | string | No | A JSON string that contains the prompts. | {"prompts":"I am a voice chatbot."} |
| Name | string | No | The agent name. | Voice bot Xiao Yun |
| Description | string | No | The agent description. | Voice bot Xiao Yun |
| InteractionConfig | object | No | The interaction configuration. | |
| SilenceDetectionConfig | object | No | The silence detection configuration. | |
| Timeout | integer | No | The timeout duration, 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 list of knowledge base IDs. | |
string | No | The knowledge base ID. | 3457xghryt | |
| TopN | integer | No | The maximum number of relevant documents to retrieve from the | 5 |
| MaxContentLength | integer | No | The maximum concatenated length of RAG content. | 2000 |
| ToolConfig | object | No | The tool configuration. | |
| McpServers | array<object> | No | The list of MCP configurations. | |
object | No | |||
| Name | string | No | The name of the MCP server configuration. | phone-ai-call |
| BaseUrl | string | No | The | |
| SseEndpoint | string | No | The path for Server-Sent Events ( | /phone-ai-call/mcp/sse?key=value |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | The response object. | ||
| Code | string | The status code of the operation. | OK |
| HttpStatusCode | integer | The HTTP status code. | 200 |
| Message | string | The response message. | success |
| RequestId | string | The request ID. | CF6D3484-19A1-5C77-863B-AC8B5754D37C |
| Data | string | The version ID. | 20904943-f711-494f-9f1f-e7f340f37707 |
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. |