本文为您介绍文本转语音外呼API使用流程。

前提条件

入参列表

参数名称 参数类型 必填与否 样例取值 参数说明
CalledShowNumber String 必须 400111**** 被叫显号。
CalledNumber String 必须 1390000**** 被叫号码。
TtsCode String 必须 TTS_10001 TTS文本模板Code。
TtsParam String 可选 {"AckNum":"123456"} 替换TTS模板中变量的JSON串。
OutId String 可选 abcdefgh 外部流水扩展字段。

出参列表

出参名称 出参类型 样例取值 参数说明
RequestId String 8906582E-6722 请求ID。
Code String OK 状态码。返回OK代表请求成功,其他错误码详见错误码列表。
Message String 请求成功 状态码的描述。
CallId String 134523^4351232 调用的回执ID。

技术对接步骤

1、下载SDK工具包

SDK工具包中一共包含了2个类库,一个aliyun-php-sdk-core包,另外一个是alicom-dyvms-api包,将这两个包添加到工程的依赖当中。

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

2、编写样例程序

// 代码节选,详见aliyun-dyvms-php-sdk/api_demo/VmsDemo.php

...

class VmsDemo
{
    ...

    /**
     * 文本转语音外呼
     *
     * @return stdClass
     * @throws ClientException
     */
    public static function singleCallByTts() {

        $acsClient = static::getAcsClient();

        //组装请求对象-具体描述见控制台-文档部分内容
        $request = new SingleCallByTtsRequest();
        //必填-被叫显号
        $request->setCalledShowNumber("400111****");
        //必填-被叫号码
        $request->setCalledNumber("1390000****");
        //必填-Tts模板Code
        $request->setTtsCode("TTS_10001");
        //选填-Tts模板中的变量替换JSON,假如Tts模板中存在变量,则此处必填
        $request->setTtsParam("{\"AckNum\":\"123456\"}");
        //选填-外呼流水号
        $request->setOutId("1234");

        //hint 此处可能会抛出异常,注意catch
        $response = static::getAcsClient()->getAcsResponse($request);

        return $response;
    }
}

$response = VmsDemo::singleCallByTts();
echo "singleCallByTts接口返回的结果:\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.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 变量不支持ERL参数
isp.SYSTEM_ERROR 系统错误
isv.MOBILE_NUMBER_ILLEGAL 号码格式非法
isv.BUSINESS_LIMIT_CONTROL 触发流控
isv.PARAM_LENGTH_LIMIT 参数长度受限