用户工具

回调地址指南

回调地址指南

为了增加UCPaaS平台的灵活性,也为了第三方服务器(AS)能够灵活的控制发送给UCPaaS的业务请求,平台为开发者提供可供自定义配置的应用回调地址(Callback API)服务。如果勾选并配置相关回调地址,UCPaaS会主动根据回调地址信息发送HTTP请求给AS,例如:将呼叫的状态信息通知给AS,即UCPaaS的回调机制。

多数情况下回调服务并非所有开发者项目的必须,开发者可依据业务开展的情况酌情考虑。默认情况下我们建议开发者充分利用平台的回调地址,能为业务服务提供更丰富的体验和降低更多可控的风险。

回调地址接口类型

我们当前按照不同产品的业务场景的区分为开发者提供产品回调(Callback API)接口,开发者可针对应用使用的特定产品单独配置回调地址,亦可将所有产品配置统一的回调地址(推荐):

配置使用路径为:

  • 【开发者控制台>产品(例如语音通知)>接入的应用>修改】
  • 【开发者控制台>应用管理>点击需要修改的应用>编辑】

注意:当前我们对平台已经升级,建议你将所有的回调功能集成于--->所有产品回调地址内,该配置在未来将成为默认推荐使用的配置项。

以下为以通话为案例展示一个【通话】语音业务的请求过程:

当前提供的主要功能:

通过通话类的回调机制,AS可以实时控制用户的最大通话时长、通过主叫号码或被叫号码进行限制拨打等功能;同时,AS还可以实现精确计费功能,避免由于客户端恶意拨打,浪费开发者费用。
通过短信或语音通知类的回调机制,AS能够及时掌握业务情况的执行结果。

回调机制说明

呼叫鉴权请求

UCPaaS在收到呼叫请求时回调给AS,携带呼叫的类型、主被叫号码信息。一般情况下,AS可以根据主被叫号码信息进行以下控制:

  • 是否允许呼叫继续
  • 控制呼叫的最大通话时长
  • 是否进行录音操作
  • 控制被叫显示的号码

注意事项:

如果应用配置中配置了“呼叫鉴权”回调地址,则UCPaaS会触发“呼叫鉴权请求”,UCPaaS会等待收到回调响应后,才继续后续呼叫;因此应用中必须配置正确的回调地址,并且能够及时返回回调响应消息,否则可能导致呼叫失败。

呼叫建立通知

UCPaaS在呼叫建立后(即被叫接通电话)回调给AS,携带呼叫类型、主被叫号码信息:一般情况下,AS根据此回调对该呼叫启动计费:

呼叫挂机计费

UCPaaS在呼叫拆除后(即主叫或被叫挂断电话)回调给AS,携带主被叫信息,通话的开始、结束时间,通话录音地址,挂机原因。一般情况下,AS可以做以下操作:

  • 对该呼叫停止计费
  • 根据通话起始、结束时间对该呼叫计费
  • 根据录音地址,获取该呼叫的录音文件

状态通知接口

UCPaaS的短信验证码语音验证码语音通知业务,通过状态通知接口将执行的结果信息异步回调给AS,以便AS能够掌握发送结果。

最后更改: 2016/12/24 12:21

页面工具