API概览

更新时间:
复制 MD 格式

API标准及多语言预置SDK

本产品(BailianVoiceBot/2025-01-01)的OpenAPI采用RPC签名风格。我们已经为开发者封装了常见编程语言的SDK,开发者可通过下载SDK直接调用本产品OpenAPI而无需关心技术细节。如果现有SDK不能满足使用需求,可通过签名机制进行自签名对接。由于自签名细节非常复杂,需花费 5个工作日左右。因此建议加入我们的服务钉钉群(147535001692),在专家指导下进行签名对接。

在使用API前,您需要准备好身份账号及访问密钥(AccessKey),才能有效通过客户端工具(SDK、CLI等)访问API。细节请参见获取AccessKey。

自定义签名场景

若您的业务场景有特殊需求,需通过自签名方式对接 API,建议优先咨询我们的技术支持团队(服务钉钉群:147535001692),获取专业指导以确保高效接入。

账号与安全准备

阿里云账号具备对所有资源的完全管理权限。一旦 AccessKey 泄露,所有相关资源都将面临未经授权访问的风险。为确保安全,建议创建一个仅具备 API 访问权限的RAM用户并配置其 AccessKey,同时基于最小权限原则 (PoLP) 配置 RAM 策略。仅在明确需要阿里云账号权限的特定场景下,才使用阿里云账号。

API目录

API

标题

API概述

BridgeWebCall软电话测试通话创建软电话测试通话。
GetDataChannelCredential获取数据通道凭证获取数据通道凭证。
GenerateFileUploadParams获取文件上传参数获取文件上传信息

MQ消息订阅配置

API

标题

API概述

UpdateSubscription更新订阅信息创建或更新MQ配置
GetSubscription获取消息订阅配置信息获取MQ配置
DisableSubscription关闭消息订阅禁用消息订阅

变量管理

API

标题

API概述

DeleteVariable删除变量删除变量
ListVariable获取变量列表获取变量列表
UpdateVariable更新变量更新变量
CreateVariable创建变量创建变量

三方语音配置

API

标题

API概述

ListVoiceEngines获取三方语音引擎列表获取引擎列表
UpdateVoiceAccessProfile更新三方语音配置更新三方语音配置
ListVoiceAccessProfile获取三方语音配置列表获取三方语音配置列表
DeleteVoiceAccessProfile删除三方语音配置删除三方语音配置
CreateVoiceAccessProfile创建三方语音配置创建实例

热词管理

API

标题

API概述

UpdateVocabulary更新热词更新实例
ListVocabulary获取热词列表获取实例详情
ImportVocabulary导入热词导入热词
GetVocabulary获取热词信息获取实例详情
ExportVocabulary导出热词导出热词
DeleteVocabulary删除热词删除场景
CreateVocabulary创建热词创建实例

克隆音管理

API

标题

API概述

ListCloneVoiceModels获取克隆音模型列表获取克隆音色可用模型列表
DeleteCloneVoice删除克隆音删除场景
ListCloneVoice获取克隆音列表获取实例详情
UpdateCloneVoice更新克隆音更新实例
CreateCloneVoice创建克隆音创建克隆音

应用管理

API

标题

API概述

DeleteApplication删除语音机器人应用删除应用
ListNluModels获取对话大模型列表获取对话模型列表
PreviewVoiceTTS合成试听试听
ListBackgroundMusics获取背景音列表获取背景音列表
ListVoices获取音色列表获取音色列表
ListApplications查询语音机器人应用列表查询语音机器人应用列表。
CreateApplicationVersion创建语音机器人应用版本创建语音机器人应用版本。
UpdateApplication修改语音机器人应用修改语音机器人应用。
CreateApplication创建语音机器人应用创建语音机器人应用。
GetApplication获取语音机器人应用获取语音机器人应用。
UpdateApplicationVersion修改语音机器人应用版本修改场景版本。
PublishApplicationVersion发布语音机器人发布语音机器人版本