通过API使用语音通知/语音验证码

语音通知/语音验证码是通过电话呼叫的方式向指定号码发送语音通知或对验证码进行语音播报,您可以调用API接口发送语音通知语音验证码

使用须知

  • 文本转语音模板和语音通知文件审核通过后才可以使用。

  • 同一个“资质+用途”下的主叫有流控限制:1次/分钟、5次/小时、20次/24小时(从第一次正常外呼开始计时),请合理使用。

准备工作

  • 若选用公共模式外呼(推荐使用),您无需自行购买号码,由阿里云提供统一的号码池。若选用专属模式外呼则需要申请真实号码

  • 调用API接口前,您可以查看API概览了解接口说明,并查询必选的请求参数。发送请求后报错时,您可以在API错误码文档中获取错误信息。

使用流程

image

步骤一:外呼内容准备

外呼内容包含文本转语音模板和语音文件,推荐您使用控制台申请外呼内容并查询审核状态,审核通过后即可发起语音外呼。

  • 文本转语音模板:暂不支持通过API接口创建,请通过语音服务控制台创建。操作步骤请参见创建语音模板

  • 语音文件:支持通过API、SDK接口上传和控制台上传,调用API或使用SDK上传操作步骤请参见通过API上传语音文件

    语音文件上传后,您可通过QueryVoiceFileAuditInfo查询审核状态,若审核不通过,请查看失败原因后重新上传语音文件。

重要

通过API上传语音文件,默认为专属模式外呼。如您计划通过公共模式调用API发起语音通话,请至语音服务控制台申请外呼内容,操作步骤请参见创建语音模板

步骤二:发起语音通话

根据业务需要调用相应的API接口发起语音通知或语音验证码,在调用接口前请仔细阅读参数描述。

通用接口

仅支持专属模式接口

  • SingleCallByVoice:向指定号码发送语音通知文件类型的语音通知。

  • SingleCallByTts:向指定号码发送语音验证码文本转语音类型的语音通知。

  1. 创建语音通话任务-CreateCallTask:使用虚拟号码给多个被叫号码创建文本转语音任务、语音通知任务和语音验证码任务。

  2. 执行语音通话任务-ExecuteCallTask:启动已创建的语音通话任务。

步骤三:查询通话详情

通用接口

仅支持专属模式接口

  • 使用API接口:调用QueryCallDetailByCallId接口,使用步骤二中发起语音通话时接口返回的CallId,查询语音通知/验证码发送详情。

  • 使用回执消息:您可以通过消息队列或HTTP批量推送模式来接收语音服务的呼叫记录、状态信息。回执消息配置流程,请参见回执消息简介与配置流程

ListCallTaskDetail:使用步骤二中执行通话任务返回的任务ID,查看指定任务详情列表。

完整示例

更多调用示例及完整工程,请参见OpenAPI开发者门户

相关文档