文档

SingleCallByVoice

更新时间:

本文为您详细介绍语音文件外呼API的使用流程。

前提条件

入参列表

参数名称

参数类型

是否必填

样例取值

参数说明

CalledShowNumber

String

4001112222

被叫显号。

CalledNumber

String

1390000****

被叫号码。

VoiceCode

String

2d4c-4e78-8d2a-afbb06cf6216.wav

语音文件Code。

Volume

Integer

100

音量。

PlayTimes

Integer

3

播放次数(最多3次)。

OutId

String

abcdefgh

预留给调用方使用的ID,最终会通过在回执消息中将此ID带回给调用方(15个字符及以内)。

出参列表

出参名称

出参类型

样例取值

参数说明

RequestId

String

8906582E-6722

请求ID。

Code

String

OK

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

Message

String

请求成功

状态码的描述。

CallId

String

134523^4351232

调用的回执ID。

技术对接步骤

  1. 下载SDK工具包

    • DK工具包中一共包含了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";
           //语音API服务产品域名(接口地址固定,无需修改)
            final String domain = "dyvmsapi.aliyuncs.com";
    
            // 阿里云账号AccessKey拥有所有API的访问权限,建议您使用RAM用户进行API访问或日常运维。
            // 强烈建议不要把AccessKey ID和AccessKey Secret保存到工程代码里,否则可能导致AccessKey泄露,威胁您账号下所有资源的安全。
            // 本示例以把AccessKey ID和AccessKey Secret保存在环境变量为例说明,来实现API访问的身份验证。
            final String accessKeyId = System.getenv("VMS_AK_ENV");
            final 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);
    
            //组装请求对象
            SingleCallByVoiceRequest request = new SingleCallByVoiceRequest();
            //必填-被叫显号,可在语音控制台中找到所购买的显号
            request.setCalledShowNumber("02500****");
            //必填-被叫号码
            request.setCalledNumber("150000****");
            //必填-语音文件ID
            request.setVoiceCode("3a7c382b-ee87-493f-bfa0-b9fd6f31f8bb.wav");
            //可选-音量取值范围 0--200
            request.setVolume(100);
            //可选-播放次数
            request.setPlayTimes(3);
            //可选-外部扩展字段
            request.setOutId("yourOutId");
    
            //请求失败这里会抛异常
            SingleCallByVoiceResponse singleCallByVoiceResponse = acsClient.getAcsResponse(request);
    
            if(singleCallByVoiceResponse.getCode()!=null && singleCallByVoiceResponse.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

触发流控

  • 本页导读 (1)
文档反馈