更新时间:2024-09-24 GMT+08:00
分享

申请资源

语音回呼

表1 语音回呼需准备的资源

资源项

对应接口参数

用途

获取方式

APP_Key

X-AKSK

X-AKSK鉴权所需参数。

登录管理控制台,从“应用管理”页面获取。

创建应用,请参考添加应用

APP_Secret

APP接入地址

-

API调用的基地址。

访问URI

-

语音回呼场景API的接口访问URI。

语音回呼场景API获取。

主叫端显示的号码

displayNbr

主叫端接收到平台来电时的显示号码。可申请多个。该号码可以与displayCalleeNbr配置为同一个号码,也可以配置为不同号码。

订购号码页面申请。

号码下发后在号码管理页面获取。

被叫端显示的号码

displayCalleeNbr

被叫端接收到平台来电时的显示号码。该号码可以与displayNbr配置为同一个号码,也可以配置为不同号码。

放音文件(可选)

lastMinVoice

若设置了最大通话时长,平台会于最后一分钟时进行放音提示。

  • 若需使用个性化放音,可提交该资源。
  • 若不提交,使用默认放音“本次通话时长还剩1分钟”

登录管理控制台,从“放音文件管理”页面获取。

上传放音文件,请参考添加放音文件

具体制作方法参见制作放音文件

waitVoice

主叫接听平台来电后的等待音。

  • 若需使用个性化放音,可提交该资源。
  • 若不提交,使用默认回铃音,例如:“嘟...嘟...”。

呼叫状态通知URL(可选)

statusUrl

接收呼叫过程中状态信息(振铃、应答、挂机等)的服务器地址。若需订阅呼叫状态通知,可提交该资源。

提前准备可用的服务器地址,创建应用时填写,或调用接口时填写。

创建应用,请参考添加应用

话单通知URL(可选)

feeUrl

接收呼叫结束后产生话单的服务器地址。若需订阅话单通知,可提交该资源。

准备的数据与语音回呼场景API请求参数关联关系如下:

表2 语音回呼录音功能需准备的资源

资源项

对应接口参数

用途

获取方式

放音文件(可选)

recordHintTone

平台会于录音前放音,提示通话用户。

  • 若需使用个性化放音,可提交该资源。
  • 若不提交,使用默认放音。

登录管理控制台,从“放音文件管理”页面获取。

上传放音文件,请参考添加放音文件

具体制作方法参见制作放音文件

获取录音文件

录音文件名

fileName

下载录音文件时使用。

通过“话单通知API”的recordObjectName参数获取。

录音文件存储的服务器域名

recordDomain

通过“话单通知API”的recordDomain参数获取。

  • 使用录音功能,需在添加应用时开通。
  • 使用录音功能必须订阅话单通知。不订阅话单通知,则无法获取下载录音文件的关键参数。

语音通知

表3 语音通知需准备的资源

资源项

对应接口参数

用途

获取方式

APP_Key

X-AKSK

X-AKSK鉴权所需参数。

登录管理控制台,从“应用管理”页面获取。

创建应用,请参考添加应用

APP_Secret

APP接入地址

-

API调用的基地址。

访问URI

-

语音通知API的接口访问URI。

语音通知API获取。

被叫用户端显示的号码

displayNbr

用户接收到平台来电时的显示号码。可申请多个。

订购号码页面申请。

号码下发后在号码管理页面获取。

放音文件

notifyVoice

音频文件,用户接听平台来电后的语音通知内容。

登录管理控制台,从“放音文件管理”页面获取。

上传放音文件,请参考添加放音文件

具体制作方法参见制作放音文件

语音通知模板ID(可选)

templateId

  • 仅接口版本为v2.0时需申请。
  • 语音通知模板唯一标识。
  • 语音通知模板为文本格式,平台将其转化为用户接听来电后的语音通知。可申请多个语音通知模板。

登录管理控制台,从“语音模板管理”页面获取。

添加语音通知模板,请参考添加语音模板

呼叫状态通知URL(可选)

statusUrl

接收呼叫过程中状态信息(振铃、应答、挂机等)的服务器地址。若需订阅呼叫状态通知,可提交该资源。

提前准备可用的服务器地址,创建应用时填写,或调用接口时填写。

创建应用,请参考添加应用

话单通知URL(可选)

feeUrl

接收呼叫结束后产生话单的服务器地址。若需订阅话单通知,可提交该资源。

准备的数据与语音通知API请求参数关联关系如下:

语音验证码

表4 语音验证码需准备的资源

资源项

对应接口参数

用途

获取方式

APP_Key

X-AKSK

X-AKSK鉴权所需参数。

登录管理控制台,从“应用管理”页面获取。

创建应用,请参考添加应用

APP_Secret

APP接入地址

-

API调用的基地址。

访问URI

-

语音验证码场景API的接口访问URI。

语音验证码场景API获取。

被叫用户端显示的号码

displayNbr

用户接收到平台来电时的显示号码。可申请多个。

订购号码页面申请。

号码下发后在号码管理页面获取。

放音文件

preTone

播放语音验证码之前播放的放音文件。

登录管理控制台,从“放音文件管理”页面获取。

上传放音文件,请参考添加放音文件

具体制作方法参见制作放音文件

放音文件(可选)

posTone

播放语音验证码之后播放的放音文件。

  • 若使用个性化放音,可提交该资源。
  • 若不申请,平台将在语音验证码播放完毕后结束通话。

呼叫状态通知URL(可选)

statusUrl

接收呼叫过程中状态信息(振铃、应答、挂机等)的服务器地址。若需订阅呼叫状态通知,可提交该资源。

提前准备可用的服务器地址,创建应用时填写,或调用接口时填写。

创建应用,请参考添加应用

话单通知URL(可选)

feeUrl

接收呼叫结束后产生话单的服务器地址。若需订阅话单通知,可提交该资源。

准备的数据与语音验证码API请求参数关联关系如下:

相关文档