API standards and SDKs in multiple languages
The OpenAPI of this product (BailianVoiceBot/2025-01-01) uses the RPC signing style. We have encapsulated SDKs for common programming languages. You can download an SDK to call the OpenAPI of this product directly without dealing with technical details. If the existing SDKs do not meet your requirements, you can integrate with the API by using the signing mechanism to sign requests yourself. Self-signing details are complex and take approximately 5 business days. Therefore, we recommend joining our DingTalk support group (147535001692) and completing the signing integration under expert guidance.
Before you use the API, you must prepare an account and an AccessKey pair so that you can effectively access the API by using client tools such as SDKs and CLIs. For more information, see Create an AccessKey pair.
Custom signing scenarios
If your business scenario has special requirements and you need to integrate with the API by using self-signed requests, we recommend that you consult our technical support team first (DingTalk support group: 147535001692) for professional guidance to ensure efficient integration.
Account and security preparation
An Alibaba Cloud account has full administrative permissions on all resources. Once an AccessKey pair is leaked, all related resources are exposed to the risk of unauthorized access. To ensure security, we recommend that you create a RAM user that has only API access permissions, configure its AccessKey pair, and configure RAM policies based on the principle of least privilege (PoLP). Use the Alibaba Cloud account only in specific scenarios where its permissions are explicitly required.
API catalog
API | Title | API overview |
|---|---|---|
| BridgeWebCall | Softphone test call | Creates a softphone test call. |
| GetDataChannelCredential | Get data channel credentials | Retrieves data channel credentials. |
| GenerateFileUploadParams | Get file upload parameters | Retrieves file upload information. |
MQ message subscription configuration
API | Title | API overview |
|---|---|---|
| UpdateSubscription | Update subscription information | Creates or updates an MQ configuration. |
| GetSubscription | Get message subscription configuration | Retrieves the MQ configuration. |
| DisableSubscription | Disable message subscription | Disables message subscription. |
Variable management
API | Title | API overview |
|---|---|---|
| DeleteVariable | Delete a variable | Deletes a variable. |
| ListVariable | List variables | Lists variables. |
| UpdateVariable | Update a variable | Updates a variable. |
| CreateVariable | Create a variable | Creates a variable. |
Third-party speech configuration
API | Title | API overview |
|---|---|---|
| ListVoiceEngines | List third-party speech engines | Lists engines. |
| UpdateVoiceAccessProfile | Update a third-party speech configuration | Updates a third-party speech configuration. |
| ListVoiceAccessProfile | List third-party speech configurations | Lists third-party speech configurations. |
| DeleteVoiceAccessProfile | Delete a third-party speech configuration | Deletes a third-party speech configuration. |
| CreateVoiceAccessProfile | Create a third-party speech configuration | Creates an instance. |
Hotword management
API | Title | API overview |
|---|---|---|
| UpdateVocabulary | Update hotwords | Updates an instance. |
| ListVocabulary | List hotwords | Retrieves instance details. |
| ImportVocabulary | Import hotwords | Imports hotwords. |
| GetVocabulary | Get hotword information | Retrieves instance details. |
| ExportVocabulary | Export hotwords | Exports hotwords. |
| DeleteVocabulary | Delete hotwords | Deletes a scenario. |
| CreateVocabulary | Create hotwords | Creates an instance. |
Cloned voice management
API | Title | API overview |
|---|---|---|
| ListCloneVoiceModels | List voice cloning models | Lists the models available for voice cloning. |
| DeleteCloneVoice | Delete a cloned voice | Deletes a scenario. |
| ListCloneVoice | List cloned voices | Retrieves instance details. |
| UpdateCloneVoice | Update a cloned voice | Updates an instance. |
| CreateCloneVoice | Create a cloned voice | Creates a cloned voice. |
Application management
API | Title | API overview |
|---|---|---|
| DeleteApplication | Delete a voice bot application | Deletes an application. |
| ListNluModels | List conversational large language models | Lists conversational models. |
| PreviewVoice | TTS synthesis preview | Previews speech. |
| ListBackgroundMusics | List background music | Lists background music. |
| ListVoices | List voices | Lists voices. |
| ListApplications | List voice bot applications | Lists voice bot applications. |
| CreateApplicationVersion | Create a voice bot application version | Creates a voice bot application version. |
| UpdateApplication | Modify a voice bot application | Modifies a voice bot application. |
| CreateApplication | Create a voice bot application | Creates a voice bot application. |
| GetApplication | Get a voice bot application | Retrieves a voice bot application. |
| UpdateApplicationVersion | Modify a voice bot application version | Modifies a scenario version. |
| PublishApplicationVersion | Publish a voice bot | Publishes a voice bot version. |