Skip to main content

API overview

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

BridgeWebCallSoftphone test callCreates a softphone test call.
GetDataChannelCredentialGet data channel credentialsRetrieves data channel credentials.
GenerateFileUploadParamsGet file upload parametersRetrieves file upload information.

MQ message subscription configuration

API

Title

API overview

UpdateSubscriptionUpdate subscription informationCreates or updates an MQ configuration.
GetSubscriptionGet message subscription configurationRetrieves the MQ configuration.
DisableSubscriptionDisable message subscriptionDisables message subscription.

Variable management

API

Title

API overview

DeleteVariableDelete a variableDeletes a variable.
ListVariableList variablesLists variables.
UpdateVariableUpdate a variableUpdates a variable.
CreateVariableCreate a variableCreates a variable.

Third-party speech configuration

API

Title

API overview

ListVoiceEnginesList third-party speech enginesLists engines.
UpdateVoiceAccessProfileUpdate a third-party speech configurationUpdates a third-party speech configuration.
ListVoiceAccessProfileList third-party speech configurationsLists third-party speech configurations.
DeleteVoiceAccessProfileDelete a third-party speech configurationDeletes a third-party speech configuration.
CreateVoiceAccessProfileCreate a third-party speech configurationCreates an instance.

Hotword management

API

Title

API overview

UpdateVocabularyUpdate hotwordsUpdates an instance.
ListVocabularyList hotwordsRetrieves instance details.
ImportVocabularyImport hotwordsImports hotwords.
GetVocabularyGet hotword informationRetrieves instance details.
ExportVocabularyExport hotwordsExports hotwords.
DeleteVocabularyDelete hotwordsDeletes a scenario.
CreateVocabularyCreate hotwordsCreates an instance.

Cloned voice management

API

Title

API overview

ListCloneVoiceModelsList voice cloning modelsLists the models available for voice cloning.
DeleteCloneVoiceDelete a cloned voiceDeletes a scenario.
ListCloneVoiceList cloned voicesRetrieves instance details.
UpdateCloneVoiceUpdate a cloned voiceUpdates an instance.
CreateCloneVoiceCreate a cloned voiceCreates a cloned voice.

Application management

API

Title

API overview

DeleteApplicationDelete a voice bot applicationDeletes an application.
ListNluModelsList conversational large language modelsLists conversational models.
PreviewVoiceTTS synthesis previewPreviews speech.
ListBackgroundMusicsList background musicLists background music.
ListVoicesList voicesLists voices.
ListApplicationsList voice bot applicationsLists voice bot applications.
CreateApplicationVersionCreate a voice bot application versionCreates a voice bot application version.
UpdateApplicationModify a voice bot applicationModifies a voice bot application.
CreateApplicationCreate a voice bot applicationCreates a voice bot application.
GetApplicationGet a voice bot applicationRetrieves a voice bot application.
UpdateApplicationVersionModify a voice bot application versionModifies a scenario version.
PublishApplicationVersionPublish a voice botPublishes a voice bot version.