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

前提条件

入参列表

参数名称 参数类型 必填与否 样例取值 参数说明
CalledShowNumber String 必须 4001112222 被叫显号。
CalledNumber String 必须 1390000**** 被叫号码。
StartCode String 必须 2d4c-4e78-8d2a-afbb06cf****.wav或者TTS_1234 呼叫开始时播放的提示音。语音文件Code名称或者Tts模板Code,类型选择必须与ByeCode保持一致。
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 播放结束时播放的结束提示音,支持语音文件和Tts2种方式,但是要求Tts中不支持变量,类型选择必须与StartCode保持一致。
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&DEMO下载地址,请参见SDK&DEMO下载

  2. 编写样例程序
    // 代码节选,详见aliyun-dyvms-php-sdk/api_demo/VmsDemo.php
    
    ...
    
    class VmsDemo
    {
        ...
    
        /**
         * 交互式语音应答
         *
         * @return stdClass
         * @throws ClientException
         */
        public static function ivrCall() {
    
            //组装请求对象-具体描述见控制台-文档部分内容
            $request = new IvrCallRequest();
            //必填-被叫显号
            $request->setCalledShowNumber("0534475****");
            //必填-被叫号码
            $request->setCalledNumber("1390000****");
            //选填-外呼流水号
            $request->setPlayTimes(3);
    
    
    
            //必填-语音文件ID或者tts模板的模板号,有参数的模板需要设置模板变量的值
            //$request->setStartCode("ebe3a2b5-c287-42a4-8299-fc40ae79****.wav");
            $request->setStartCode("TTS_713900000");
            $request->setStartTtsParams("{\"product\":\"aliyun\",\"code\":\"123\"}");
            $menuKeyMaps = array();
    
            $menuKeyMap1 = new MenuKeyMap();
            $menuKeyMap1->setKey("1");
            $menuKeyMap1->setCode("9a9d7222-670f-40b0-****.wav");
            $menuKeyMaps[] = $menuKeyMap1;
    
            $menuKeyMap2 = new MenuKeyMap();
            $menuKeyMap2->setKey("2");
            $menuKeyMap2->setCode("44e3e577-3d3a-418f-****.wav");
            $menuKeyMaps[] = $menuKeyMap2;
    
            $menuKeyMap3 = new MenuKeyMap();
            $menuKeyMap3->setKey("3");
            $menuKeyMap3->setCode("TTS_71390000");
            $menuKeyMap3->setTtsParams("{\"product\":\"aliyun\",\"code\":\"123\"}");
            $menuKeyMaps[] = $menuKeyMap3;
    
            $request->setMenuKeyMaps($menuKeyMaps);
            //结束语可以使一个无参模板或者一个语音文件ID
            $request->setByeCode("TTS_71400007");
    
    
            //选填-外呼流水号
            $request->setOutId("yourOutId");
    
            //hint 此处可能会抛出异常,注意catch
            $response = static::getAcsClient()->getAcsResponse($request);
    
            return $response;
        }
    }
    
    $response = VmsDemo::ivrCall();
    echo "交互式语音应答(ivrCall)接口返回的结果:\n";
    print_r($response);
    
                

错误码列表

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 触发流控