本文为您介绍文本转语音外呼API使用流程。
前提条件
开通语音服务。具体操作。请参见开通服务。
获取AccessKey。具体操作,请参见获取AccessKey。
购买号码。具体操作,请参见真实号管理。
创建文本转语音模板或上传语音文件。具体操作,请参见创建文本转语音模板和通过控制台上传语音文件。
入参列表
参数名称 | 参数类型 | 必填与否 | 样例取值 | 参数说明 |
CalledShowNumber | String | 必须 | 400111**** | 被叫显号。 |
CalledNumber | String | 必须 | 1390000**** | 被叫号码。 |
TtsCode | String | 必须 | TTS_10001 | TTS文本模板Code。 |
TtsParam | String | 可选 | {"AckNum":"123456"} | 替换TTS模板中变量的JSON串。 |
Volume | Integer | 可选 | 100 | 音量。 |
PlayTimes | Integer | 可选 | 3 | 播放次数(最多3次)。 |
OutId | String | 可选 | abcdefgh | 预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。 |
出参列表
出参名称 | 出参类型 | 样例取值 | 参数说明 |
RequestId | String | 8906582E-6722 | 请求ID。 |
Code | String | OK | 状态码。返回OK代表请求成功,其他错误码详见错误码列表。 |
Message | String | 请求成功 | 状态码的描述。 |
CallId | String | 134523^4351232 | 调用的回执ID。 |
技术对接步骤
下载SDK工具包
SDK工具包中一共包含了2个类库,一个aliyun-java-sdk-core包,另外一个是alicom-dyvms-api包,将这两个包执行mvn package命令或者mvn deploy命令打包出相应的jar包,添加到工程类库中依赖使用。
SDK&DEMO下载地址,请参见SDK&DEMO下载。
编写样例程序
说明调用接口前,需配置环境变量,通过环境变量读取访问凭证。AccessKey ID和AccessKey Secret的环境变量名:VMS_AK_ENV 、VMS_SK_ENV。配置详情请参见配置访问凭证。
//设置访问超时时间 System.setProperty("sun.net.client.defaultConnectTimeout", "10000"); System.setProperty("sun.net.client.defaultReadTimeout", "10000"); //云通信产品-语音API服务产品名称(产品名固定,无需修改) final String product = "Dyvmsapi"; //产品域名(接口地址固定,无需修改) final String domain = "dyvmsapi.aliyuncs.com"; // 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。 // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。 // 本示例以将AccessKey ID和AccessKey Secret保存在环境变量为例说明。您也可以根据业务需要,保存到配置文件里。 String accessKeyId = System.getenv("VMS_AK_ENV"); String accessKeySecret = System.getenv("VMS_SK_ENV"); //初始化acsClient 暂时不支持多region IClientProfile profile = DefaultProfile.getProfile("cn-hangzhou", accessKeyId, accessKeySecret); DefaultProfile.addEndpoint("cn-hangzhou", "cn-hangzhou", product, domain); IAcsClient acsClient = new DefaultAcsClient(profile); SingleCallByTtsRequest request = new SingleCallByTtsRequest(); //必填-被叫显号,可在语音控制台中找到所购买的显号 request.setCalledShowNumber("0256000****"); //必填-被叫号码 request.setCalledNumber("150000****"); //必填-Tts模板ID request.setTtsCode("TTS_000000"); //可选-当模板中存在变量时需要设置此值 request.setTtsParam("{\"code\":\"123456\"}"); //可选-音量取值范围 0--200 request.setVolume(100); //可选-播放次数 request.setPlayTimes(3); //可选-外部扩展字段,此ID将在回执消息中带回给调用方 request.setOutId("yourOutId"); //hint 此处可能会抛出异常,注意catch SingleCallByTtsResponse singleCallByTtsResponse = acsClient.getAcsResponse(request); if(singleCallByTtsResponse.getCode() != null && singleCallByTtsResponse.getCode().equals("OK")) { //请求成功 System.out.println("语音文本外呼---------------"); System.out.println("RequestId=" + singleCallByTtsResponse.getRequestId()); System.out.println("Code=" + singleCallByTtsResponse.getCode()); System.out.println("Message=" + singleCallByTtsResponse.getMessage()); System.out.println("CallId=" + singleCallByTtsResponse.getCallId()); }
错误码列表
Code | 描述 |
OK | 请求成功 |
isp.RAM_PERMISSION_DENY | RAM权限DENY |
isv.OUT_OF_SERVICE | 业务停机 |
isv.PRODUCT_UN_SUBSCRIPT | 未开通云通信产品的阿里云客户 |
isv.OUT_OF_SERVICE | 业务停机 |
isv.PRODUCT_UNSUBSCRIBE | 产品未开通 |
isv.ACCOUNT_NOT_EXISTS | 账户不存在 |
isv.ACCOUNT_ABNORMAL | 账户异常 |
isv.TTS_TEMPLATE_ILLEGAL | TTS模板不合法 |
isv.DISPLAY_NUMBER_ILLEGAL | 号显不合法 |
isv.TEMPLATE_MISSING_PARAMETERS | 文本转语音模板参数缺失 |
isv.BLACK_KEY_CONTROL_LIMIT | 模板变量中存在黑名单关键字 |
isv.INVALID_PARAMETERS | 参数异常 |
isv.PARAM_NOT_SUPPORT_URL | 变量不支持URL参数 |
isp.SYSTEM_ERROR | 系统错误 |
isv.MOBILE_NUMBER_ILLEGAL | 号码格式非法 |
isv.BUSINESS_LIMIT_CONTROL | 触发流控 |
isv.PARAM_LENGTH_LIMIT | 参数长度受限 |