文档首页 > > 开发指南> 开发准备> 申请资源

申请资源

分享
更新时间: 2019/10/22 GMT+08:00

登录授权

表1 登录授权需准备的资源

资源项

对应接口参数

用途

对应接口

获取方式

APP_Key

app_key

语音回呼能力唯一标识。

所有

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

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

APP_Secret

app_secret

刷新授权access_token时携带。

刷新授权API

APP接入地址

-

API调用的基地址。

所有

开发者账号

username

请求URL的必填参数。

大客户SP简单认证API

开通服务后将以短信的方式通知SP,请在控制台 >> 总览页面的联系人电话的短信中查看。开发者账号也可直接在控制台 >> 总览页面查看。

开发者密码

Authorization

请求Headers的必填参数。

刷新令牌

refresh_token

access_token即将过期时使用refresh_token重新向RTC业务平台申请新的access_token,避免access_token过期后业务失败。

刷新授权API

调用“大客户认证简单认证API”认证RTC业务平台时,RTC业务平台返回的refresh_token字段的值。

访问令牌

access_token

用于RTC业务平台对应用进行鉴权。

取消授权API

调用“大客户SP简单认证API”即fastlogin鉴权接口,在RTC业务平台成功登录后,由RTC业务平台返回成功响应消息的access_token参数值。

准备的数据与大客户SP简单认证API请求参数关联关系如下:

语音回呼

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

资源项

对应接口参数

用途

对应接口

获取方式

APP_Key

app_key

语音回呼能力唯一标识。

所有

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

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

APP_Secret

app_secret

刷新授权access_token时携带。

刷新授权API

APP接入地址

-

API调用的基地址。

所有

访问令牌

access_token

用于RTC业务平台对应用进行鉴权。

  • 语音回呼场景API
  • 终止呼叫场景API
  • 修改呼叫记忆数据API
  • 查询呼叫记忆数据API

调用“大客户SP简单认证API”即fastlogin鉴权接口,在RTC业务平台成功登录后,由RTC业务平台返回成功响应消息的access_token参数值。

CallEnabler业务号码

bindNbr

与app_key绑定的号码,平台呼叫主叫时使用。

语音回呼场景API

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

添加业务,请参考添加业务

主叫端来电显示号码

displayNbr

主叫端接收到平台来电时的显示号码。可申请多个。

被叫端来电显示号码

displayCalleeNbr

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

放音文件(可选)

lastMinVoice

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

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

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

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

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

waitVoice

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

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

呼叫状态通知URL(可选)

statusUrl

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

  • 语音回呼场景API
  • 呼叫状态通知API

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

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

话单通知URL(可选)

feeUrl

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

  • 语音回呼场景API
  • 话单通知API

若需开启语音回呼的呼叫记忆功能,需提前向管理员申请,并告知管理员需要的呼叫记忆保存时长(最大7天),且被叫端来电显示号码需使用平台提供的开户号码。

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

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

资源项

对应接口参数

用途

对应接口

获取方式

放音文件(可选)

recordHintTone

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

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

语音回呼场景API

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

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

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

获取录音文件-方式一(推荐)

录音文件名

fileName

下载录音文件时使用。

获取录音文件下载地址API

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

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

recordDomain

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

获取录音文件-方式二

录音服务器地址

-

平台存放录音文件的服务器地址,下载录音文件时使用。

话单通知API

  • 将话单通知“recordDomain”参数中的域名进行DNS解析,获取IP。
  • 如果不能进行DNS解析,请向管理员获取。
  • 建议至少获取两个IP地址,保证下载可靠性。

下载录音的证书AK

AK

下载录音文件时使用。

刷新访问OceanStor的证书

  • 向管理员获取。
  • 若有安全需求,需调用“刷新访问OceanStor的证书”接口定期刷新AK、SK。

下载录音的证书SK

SK

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

语音通知

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

资源项

对应接口参数

用途

对应接口

获取方式

APP_Key

app_key

语音通知能力唯一标识。

所有

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

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

APP_Secret

app_secret

刷新授权access_token时携带。

刷新授权API

APP接入地址

-

API调用的基地址。

所有

访问令牌

access_token

用于RTC业务平台对应用进行鉴权。

语音通知API

调用“大客户SP简单认证API”即fastlogin鉴权接口,在RTC业务平台成功登录后,由RTC业务平台返回成功响应消息的access_token参数值。

CallEnabler业务号码

bindNbr

与app_key绑定的号码,平台呼叫主叫时使用。

语音通知API

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

添加业务,请参考添加业务

来电显示号码

displayNbr

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

放音文件

notifyVoice

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

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

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

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

语音通知模板ID(可选)

templateId

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

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

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

呼叫状态通知URL(可选)

statusUrl

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

  • 语音通知API
  • 呼叫状态通知API

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

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

话单通知URL(可选)

feeUrl

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

  • 语音通知API
  • 话单通知API

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

语音验证码

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

资源项

对应接口参数

用途

对应接口

获取方式

APP_Key

app_key

语音验证码能力唯一标识。

所有

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

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

APP_Secret

app_secret

刷新授权access_token时携带。

刷新授权API

APP接入地址

-

API调用的基地址。

所有

访问令牌

access_token

用于RTC业务平台对应用进行鉴权。

语音验证码场景API

调用“大客户SP简单认证API”即fastlogin鉴权接口,在RTC业务平台成功登录后,由RTC业务平台返回成功响应消息的access_token参数值。

CallEnabler业务号码

bindNbr

与app_key绑定的号码,平台呼叫主叫时使用。

语音验证码场景API

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

添加业务,请参考添加业务

来电显示号码

displayNbr

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

放音文件

preTone

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

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

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

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

放音文件(可选)

posTone

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

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

呼叫状态通知URL(可选)

statusUrl

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

  • 语音验证码场景API
  • 呼叫状态通知API

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

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

话单通知URL(可选)

feeUrl

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

  • 语音验证码场景API
  • 话单通知API

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

分享:

    相关文档

    相关产品

文档是否有解决您的问题?

提交成功!

非常感谢您的反馈,我们会继续努力做到更好!

反馈提交失败,请稍后再试!

*必选

请至少选择或填写一项反馈信息

字符长度不能超过200

提交反馈 取消

如您有其它疑问,您也可以通过华为云社区问答频道来与我们联系探讨

跳转到云社区