交互式语音应答

本文为您介绍交互式语音应答的使用流程。

前提条件

入参列表

参数名称

参数类型

必填与否

样例取值

参数说明

CalledShowNumber

String

必须

400111****

被叫显号。

CalledNumber

String

必须

1390000****

被叫号码。

StartCode

String

必须

2d4c-4e78-8d2a-afbb06cf****.wav或者TTS_1234

呼叫开始时播放的提示音。语音文件Code名称或者Tts模板Code。

StartTtsParams

String

可选

{"name":"xxx","code":"123"}

Tts模板变量替换JSON,当StartCode为Tts时且Tts模板中带变量的情况下此参数必填。

MenuKeyMapList

List

必须

详见SDK中的MenuKeyMap结构体

按键和播放对应提示音的Map关系。

ByeCode

String

可选

2d4c-4e78-8d2a-afbb06cf****.wav或者TTS_1234

播放结束时播放的结束提示音。支持语音文件和Tts模板2种方式,但是类型需要与StartCode一致,即前者为Tts类型的,后者也需要是Tts类型的。

ByeTtsParams

String

可选

{"name":"xxx","code":"123"}

Tts模板变量替换JSON,当ByeCode为Tts时且Tts模板中带变量的情况下此参数必填。

Timeout

Integer

可选

3000

等待用户按键超时时间,单位毫秒。

playTimes

Long

可选

3

重复播放次数(最多3次)。

OutId

String

可选

abcdefgh

预留给调用方使用的ID。最终会通过在回执消息中将此ID带回给调用方。

出参列表

出参名称

出参类型

样例取值

参数说明

RequestId

String

8906582E-6722

请求ID。

Code

String

OK

状态码。返回OK代表请求成功,其他错误码详见错误码列表。

Message

String

请求成功

状态码的描述。

CallId

String

134523^4351232

调用的回执ID。

技术对接步骤

  1. 下载SDK工具包

    • SDK工具包中一共包含了2个类库,一个aliyun-java-sdk-core包,另外一个是alicom-dyvms-api包,将这两个包执行mvn package命令或者mvn deploy命令打包出相应的jar包,添加到工程类库中依赖使用。

    • SDK&DEMO下载地址,请参见SDK&DEMO下载

  2. 编写样例程序

    说明

    调用接口前,需配置环境变量,通过环境变量读取访问凭证。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 ID拥有所有API的访问权限,风险很高。强烈建议您创建并使用RAM用户进行API访问或日常运维,请登录RAM控制台创建RAM用户
            // 此处以把AccessKey ID和 AccessKey Secret 保存在环境变量为例说明。 您也可以根据业务需要,保存到配置文件里
            // 强烈建议不要把 AccessKey ID和 AccessKey Secret 保存到代码里,会存在密钥泄漏风险
            String accessKeyId = System.getenv("VMS_AK_ENV");
            String accessSecret = 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);
    
            //组装请求对象-具体描述见控制台-文档部分内容
            IvrCallRequest request = new IvrCallRequest();
            //必填-被叫显号,可在语音控制台中找到所购买的显号
            request.setCalledShowNumber("05715621****");
            //必填-被叫号码
            request.setCalledNumber("1390000****");
            request.setPlayTimes(3L);
    
            //必填-语音文件ID或者tts模板的模板号,有参数的模板需要设置模板变量的值
            //request.setStartCode("ebe3a2b5-c287-42a4-8299-fc40ae79****.wav");
            request.setStartCode("TTS_713900000");
            request.setStartTtsParams("{\"product\":\"aliyun\",\"code\":\"123\"}");
            List<MenuKeyMap> menuKeyMaps = new ArrayList<MenuKeyMap>();
            MenuKeyMap menuKeyMap1 = new MenuKeyMap();
            menuKeyMap1.setKey("1");
            menuKeyMap1.setCode("9a9d7222-670f-40b0*****.wav");
            menuKeyMaps.add(menuKeyMap1);
            MenuKeyMap menuKeyMap2 = new MenuKeyMap();
            menuKeyMap2.setKey("2");
            menuKeyMap2.setCode("44e3e577-3d3a-418f*****.wav");
            menuKeyMaps.add(menuKeyMap2);
            MenuKeyMap menuKeyMap3 = new MenuKeyMap();
            menuKeyMap3.setKey("3");
            menuKeyMap3.setCode("TTS_71390000");
            menuKeyMap3.setTtsParams("{\"product\":\"aliyun\",\"code\":\"123\"}");
            menuKeyMaps.add(menuKeyMap3);
            request.setMenuKeyMaps(menuKeyMaps);
            //结束语可以是一个无参模板或者一个语音文件ID,但是如果StartCode是TTS类型的ByeCode也需要是TTS类型的,如果StartCode是录音类型的ByeCode也需要是录音类型的
            request.setByeCode("TTS_71400007");
            request.setTimeout(3000);
            request.setByeTtsParams("{\"product\":\"aliyun\",\"code\":\"123\"}");
            //可选-外部扩展字段
            request.setOutId("yourOutId");
    
            //hint 此处可能会抛出异常,注意catch
            IvrCallResponse ivrCallResponse = acsClient.getAcsResponse(request);
    
            if(ivrCallResponse.getCode()!=null && ivrCallResponse.getCode().equals("OK")) {
                     //请求成功
            }
                

错误码列表

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.VOICE_FILE_ILLEGAL

语音文件不合法

isv.DISPLAY_NUMBER_ILLEGAL

号显不合法

isv.INVALID_PARAMETERS

参数异常

isp.SYSTEM_ERROR

系统错误

isv.MOBILE_NUMBER_ILLEGAL

号码格式非法

isv.BUSINESS_LIMIT_CONTROL

触发流控