Retrieve a voice chatbot application.
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:GetApplication | get | *All Resource
| None | None |
Request parameters
Parameter | Type | Required | Description | Example |
|---|---|---|---|---|
| BusinessUnitId | string | Yes | Workspace ID in Alibaba Cloud Model Studio | llm-c11iig67g863rih8 |
| ApplicationId | string | Yes | Application ID. | a395011f-a247-400f-bc69-28796749fd52 |
Response elements
Element | Type | Description | Example |
|---|---|---|---|
object | |||
| Code | string | Status code | OK |
| HttpStatusCode | integer | HTTP status code | 200 |
| Message | string | Response message | success |
| RequestId | string | Request ID | D771A1B6-3D5F-174A-BEE1-98CE1000D337 |
| Data | object | Returned data | |
| ApplicationId | string | Application ID | a395011f-a247-400f-bc69-28796749fd52 |
| Name | string | Application name | test001 |
| Description | string | Application description | Describe this application |
| Concurrency | integer | Concurrent call volume, which is the number of simultaneous outbound calls. | 10 |
| CreatedTime | integer | Application creation time. | 1730081561000 |
| UpdatedTime | integer | Application modification time. | 1730081561000 |
| NluEngine | string | NLU engine | PROMPTS |
| NluAccessType | string | NLU access method | MANAGED |
| DraftVersion | object | Draft version configuration | |
| VersionId | string | Version ID | 743219815472857088 |
| TranscriberConfig | object | ASR configuration | |
| NlsEngine | string | ASR engine Valid values:
| ALIYUN |
| NlsAccessType | string | ASR invocation method Valid values:
| MANAGED |
| NlsAccessProfile | object | ||
| AccessProfileId | string | ||
| VocabularyId | string | ||
| EndSilenceTimeout | integer | ||
| CustomizationId | string | ||
| SpeechNoiseThreshold | integer | ||
| Model | string | ||
| CorrectionRules | array<object> | ||
object | |||
| Pattern | string | ||
| Replacement | string | ||
| SynthesizerConfig | object | TTS configuration | |
| NlsEngine | string | TTS engine Valid values:
| ALIYUN |
| NlsAccessType | string | TTS invocation method Valid values:
| MANAGED |
| Voice | string | Voice | aixia |
| SpeechRate | integer | Speech rate Valid values: -500 to 500. | 1 |
| Volume | integer | Volume | 50 |
| PitchRate | integer | Pitch Valid values: -500 to 500. | 5 |
| NlsAccessProfile | object | ||
| AccessProfileId | string | ||
| Model | string | ||
| PronRules | array<object> | ||
object | |||
| Pattern | string | ||
| Replacement | string | ||
| ScriptProfile | object | Application model configuration | |
| Model | string | Model | qwen-plus |
| Temperature | string | Probability threshold for nucleus sampling during generation
| 0.8 |
| TopP | string | Controls randomness and diversity of model responses
| 0.1 |
| AgentProfile | object | Agent configuration | |
| ScriptProfileTemplateId | string | Application template ID | SFM_PROMPTS_DEFAULT |
| AgentProfileId | string | Agent configuration ID. | 6a50b67072d44788951de29758432d94 |
| PromptsJson | string | Prompt JSON | {"prompts":"I am a chatbot."} |
| Description | string | Agent description | Chatbot |
| InteractionConfig | object | Interaction configuration | |
| SilenceDetectionConfig | object | Silence detection configuration | |
| Timeout | integer | Task execution timeout in seconds. | 3 |
| RagConfig | object | RAG configuration | |
| RagEngine | string | RAG engine | BAILIAN |
| Enabled | boolean | Whether RAG is enabled | false |
| KnowledgeBaseIds | array | List of knowledge base IDs | |
string | Knowledge base ID | 8345xghryt | |
| TopN | integer | Maximum number of data records to retrieve | 5 |
| MaxContentLength | integer | Maximum concatenated length of RAG content | 2000 |
| ToolConfig | object | Tool configuration | |
| McpServers | array<object> | List of MCP server configurations | |
object | |||
| Name | string | Name | phone-ai-call |
| BaseUrl | string | Base URL | |
| SseEndpoint | string | SSE path | /phone-ai-call/mcp/sse?key=value |
| PublishedVersion | object | Published application version | |
| VersionId | string | Version ID | 47889c1f-dd3f-4ace-9587-a13a3563e678 |
| TranscriberConfig | object | ASR configuration | |
| NlsEngine | string | ASR engine Valid values:
| ALIYUN |
| NlsAccessType | string | ASR invocation method Valid values:
| MANAGED |
| NlsAccessProfile | object | ||
| AccessProfileId | string | ||
| VocabularyId | string | ||
| EndSilenceTimeout | integer | ||
| CustomizationId | string | ||
| SpeechNoiseThreshold | integer | ||
| Model | string | ||
| CorrectionRules | array<object> | ||
object | |||
| Pattern | string | ||
| Replacement | string | ||
| SynthesizerConfig | object | TTS configuration | |
| NlsEngine | string | TTS engine Valid values:
| ALIYUN |
| NlsAccessType | string | TTS invocation method Valid values:
| MANAGED |
| Voice | string | Voice | aixia |
| SpeechRate | integer | Speech rate Valid values: -500 to 500. | -20 |
| Volume | integer | Volume | 50 |
| PitchRate | integer | Pitch Valid values: -500 to 500. | 3 |
| NlsAccessProfile | object | ||
| AccessProfileId | string | ||
| Model | string | ||
| PronRules | array<object> | ||
object | |||
| Pattern | string | ||
| Replacement | string | ||
| ScriptProfile | object | Application model configuration | |
| Model | string | Model | qwen-plus |
| Temperature | string | Probability threshold for nucleus sampling during generation
| 0.8 |
| TopP | string | Controls randomness and diversity of model responses
| 0.1 |
| AgentProfile | object | Agent configuration | |
| ScriptProfileTemplateId | string | Agent configuration template ID | SFM_PROMPTS_DEFAULT |
| AgentProfileId | string | Agent configuration ID | b97b6822dd624c32b6c2a54d717db718 |
| PromptsJson | string | Prompt JSON | {"prompts":"I am a chatbot."} |
| Description | string | Agent description | I am a chatbot |
| InteractionConfig | object | Interaction configuration | |
| SilenceDetectionConfig | object | Silence detection configuration | |
| Timeout | integer | Timeout duration. | 30 |
| RagConfig | object | RAG configuration | |
| RagEngine | string | RAG engine | BAILIAN |
| Enabled | boolean | Whether RAG is enabled | false |
| KnowledgeBaseIds | array | List of knowledge base IDs | |
string | Knowledge base ID | 3472xghryt | |
| TopN | integer | Maximum number of data records to retrieve | 5 |
| MaxContentLength | integer | Maximum concatenated length of RAG content | 2000 |
| ToolConfig | object | Tool configuration | |
| McpServers | array<object> | List of MCP server configurations | |
object | |||
| Name | string | Name. | phone-ai-call |
| BaseUrl | string | Base URL | |
| SseEndpoint | string | SSE path | /phone-ai-call/mcp/sse?key=value |
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. |