本文为您介绍呼入动态IVR呼转回调HTTP接口相关参数及调用示例。

场景描述

  • 多个坐席或者服务人员,使用同一个号码,对用户进行语音外呼;当某个接到该电话的用户,回拨该外呼号码时,需要把这个呼入电话,呼转到指定服务人员号码上,从而提供精准的客户服务。
  • 在商城有多个小商家入驻时,统一提供对外的呼入服务号码,和多个商家的分机号,当用户呼入该服务号码时,提示客户按键呼转到指定商家的分机号上;从而解决平台提供统一服务号码,给多个中小商家快速提供客服热线的能力。该功能也适用于企业的呼入总机服务,解决简单分机呼转需求。
  • 此时,云通信平台,根据用户呼入的主叫号码,被叫号码以及按键信息,通过URL回调查询后,获取需要转接的号码,呼转到指定的坐席或服务人员的电话上。

接口概述

  • 此URL主要用于呼入业务设置为动态IVR时,根据呼入的主叫号码、被叫号码以及按键信息通过设置的ERL回调获取呼转的号码以及外呼显示号码。
  • 此配置可分为两个维度:指定号码设置以及全局默认设置, 优先会通过获取指定号码设置的URL,若号码未指定设置则会通过默认设置。
  • 回调触发点: 当按键查询呼转开关,关闭时,接收到呼入请求直接回调。 当按键查询呼转开关,打开时,播放IVR提示音后,等待用户按键结束后进行回调。

交互协议

  • 接口协议:HTTP
  • 提交方式:Get
  • 调用超时时间:3秒
  • 字符编码:UTF-8

请求参数定义

如下定义的固定参数语音平台在呼叫过程中会自动添加到URL的请求参数上。
序号 参数名称 是否必填 备注
1 caller 必须 呼入主叫号码
2 serviceNumber 必须 呼入被叫号码
3 timestamp 必须 当前时间戳
4 uuid 必须 呼叫唯一标识
5 dtmf 可选 用户按键信息

响应参数定义:

  • 返回格式:JSON
  • 成功样式:
    {"result": "success","msg": "成功", "data": {"called": "13000000000","showNumber": "057100000000"}}
  • 失败样式:
    {"result":"fail","msg":"fail reason", "data":{}}
  • 参数说明:
    序号 参数名称 是否必填 备注
    1 called 必须 将要呼转的被叫号码。
    2 showNumber 可选 呼转显示号码。如果为空,默认会通过呼入的服务号码进行外呼。

具体示例

  1. 调用样例
    • URL如果在语音服务控制台设置的地址为:http://11.162.156.43:7001/test?action=getTransferNumber
    • 用户实际呼入时,输入按键后语音平台请求客户的实际URL为:http://11.162.156.43:7001/test?action=getTransferNumber&caller=137012345678&serviceNumber=051083484093&uuid=7e34bb6c-ec99-11e8-b18b-af10dc1a7640&dtmf=123
  2. 返回结果
    { "result": "success", "data": { "called": "13000000000", "showNumber": "051083484093" } }