文档

动态IVR呼转回调接口

语音服务支持在控制台上对全局添加号码回拨设置,当客户回拨号码时,在通话中播放指定录音文件或设置动态IVR。本文档展示动态IVR的相关设置。

前提条件

在您做IVR动态呼转的配置之前,需进行语音SIP打标,详情请咨询您的商务经理。

背景信息

当号码的呼入业务设置为动态IVR时,可以根据呼入的主叫号码、被叫号码以及按键信息通过设置的URL回调获取呼转的号码以及外呼显示号码。此配置可分为两个维度:指定号码设置以及全局默认设置,优先会通过获取指定号码设置的URL,若号码未指定设置则会通过默认设置。

回调触发点:

  • 当按键查询呼转开关关闭时,接收到呼入请求直接回调。

  • 当按键查询呼转开关打开时,播放IVR提示音后,等待用户按键结束后进行回调。

应用场景

呼转回调接口可用于以下场景:

  • 多个坐席或者服务人员,使用同一个号码,对用户进行语音外呼。当某个接到该电话的用户,回拨该外呼号码时,需要把这个呼入电话,呼转到指定服务人员号码上,从而提供精准的客户服务。

  • 在商城有多个小商家入驻时,统一提供对外的呼入服务号码,和多个商家的分机号。当用户呼入该服务号码时,提示客户按键呼转到指定商家的分机号上;从而解决平台提供统一服务号码,给多个中小商家快速提供客服热线的能力。该功能也适用于企业的呼入总机服务,解决简单分机呼转需求。

云通信平台根据用户呼入的主叫号码、被叫号码及按键信息,通过URL回调查询后,获取需要转接的号码,呼转至指定坐席或服务人员的电话。

限制说明

  • 该功能对2018年11月26号后申请的号码生效。

  • 对已配置有默认呼入的号码及后续新申请的号码生效。

  • 对已单独修改呼入配置的号码不作调整。

  • 修改配置后,约5~10秒钟后生效。

呼入设置指定为动态IVR

开启动态IVR呼转功能,需要将呼入设置指定为动态IVR,并指定URL。

  1. 登录语音服务控制台

  2. 在左侧导航栏选择通用设置

  3. 呼叫设置页签,单击修改全局配置,单击添加指定号码呼入配置

  4. 配置类型指定为动态IVR

  5. 填写URL

    此处的URL是客户自定义获取呼转被叫号码的HTTP地址,触发回拨事件后,语音服务会采集呼叫信息,自动将呼叫信息作为固定请求参数添加到此处的URL中,并发起请求。

    此处填写的格式为:

    http://IP地址:端口号/test?action=getTransferNumber

    添加参数后的示例:

    http://10.10.10.1:7001/test?action=getTransferNumber&caller=1700000****&serviceNumber=05108348****&timestamp=1691402001&uuid=7e34bb6c-ec99-11e8-b18b-af10dc1a7640&dtmf=123
    说明

    IP地址需为公网IP。

  6. 指定号码呼入配置需要选择使用公司以及被叫号码

  7. 选择访问URL失败放音查分机不存在放音以及呼转放音

  8. 单击开启禁止呼转时段设置,选择禁止呼转时段以及禁止呼转放音

  9. 如需开启按键查询呼转,单击开启按键查询呼转,进行参数配置。

    配置信息

    描述

    首次呼入放音

    被叫号码接通后放音

    无按键超时放音

    等待按键超时放音

    无按键超时时长

    等待用户按键时长

    超时次数后挂机

    最大超时次数

    重听按键配置

    重新放音文件按键

    输入结束按键配置

    输入结束按键

  10. 单击确定修改

接口规范

规范

说明

接口协议

HTTP

请求方式

POST

调用超时时间

3秒

字符编码格式

UTF-8

请求示例

http://10.10.10.1:7001/test?action=getTransferNumber&caller=1700000****&serviceNumber=05108348****&timestamp=1691402001&uuid=7e34bb6c-ec99-11e8-b18b-af10dc1a7640&dtmf=123

请求参数

如下定义的固定参数语音平台在呼叫过程中会自动添加到URL的请求参数上。

序号

参数名称

类型

是否必填

说明

1

caller

String

呼入主叫号码

2

serviceNumber

String

呼入被叫号码

3

timestamp

String

当前时间戳

4

uuid

String

呼叫唯一标识

5

dtmf

Integer

用户按键信息

返回示例

以JSON格式为例,返回示例如下:

  • 调用成功:

    {
    "result":"success",
    "msg":"成功",
    "data":{"called":"1390000****",
            "showNumber":"057100005848"}
    }
  • 调用失败:

    {"result":"fail","msg":"fail reason","data":{}}

返回参数

参数名称

类型

是否必填

说明

示例

result

String

调用结果。

  • success:调用成功。

  • fail:调用失败。

fail

msg

String

调用结果描述:

  • 成功:调用成功。

  • fail reson:调用失败原因。

未查询到有效的转接号码

data

JSON

返回数据,JSON格式。

说明

调用失败时,data为空。

{"called":"1390000****","showNumber":"057100005848"}

called

String

将要转接的被叫号码。

1390000****

showNumber

String

呼转显示号码。如果为空,默认会通过呼入的服务号码进行外呼。

057100005848

  • 本页导读 (1)
文档反馈