IVR接口

用户呼叫过程中，提供IVR交互功能。呼叫中心IVR接口主要数据结构有：

包含以下接口：

数据结构说明

获取DTMF对象

属性 类型 约束 说明
ivr appId String 必选 应用唯一标识
callId String 必选 呼叫ID
playFlag int 必选 放音文件标识 0:voiceStr 1: fileName
fileName String 必选 放音文件名，录音文件已上传
voiceStr String 必选 TTS文本 playFlay为0时提供tts文本
playTime int 必选 最多播放次数，取值大于0
maxRevCnt int 必选 最多收码个数，取值大于等于 0，为0时，key2End不能为空字符
key2End String 可选 收到指定DTMF码后结束收号，不可与maxRevCnt同时无效 (0~9、*、#、空字符)
spaceTime int 必选 最长按键间隔,以秒为单位，取值大于等于 0，为0时代表默认值：30S
totalTime int 必选 首位按键最长等待时间，以秒为单位，取值大于等于 0，为0时代表默认值：60S
data String 可选 用户透传数据

JSON 示例

JSON 示例 

{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "playFlag":0,
        "fileName":"FILE_ID",
        "voiceStr":"您的短信剩余15条",
        "playTime":3,
        "maxRevCnt":1,
        "key2End":"0",
        "spaceTime":5,
        "totalTime":30,
        " data ":" userdata ",
    }
}

XML 示例

XML 示例 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
    <appId>247e35ff320a4142a105024055c367cf </appId>
    <callId>2015100817062901467CTI</callId>
    <playFlag>0</playFlag>
    <fileName>FILE_ID</fileName>
    <voiceStr>您的短信剩余15条</voiceStr>
    <playTime>3</playTime>
    <maxRevCnt>1</maxRevCnt>
    <key2End>0</key2End>
    <spaceTime>5</spaceTime>
    <totalTime>30</totalTime> 
    <data>userdata</data>
</ivr>

播放语音对象

属性 类型 约束 说明
ivr appId String 必选 应用唯一标识
callId String 必选 呼叫ID
fileName String 必选 放音文件名(放音文件已上传)
playTime int 必选 最多播放次数 (> 0)
data String 可选 用户数据

JSON 示例

JSON 示例 

{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "fileName":"FILE_ID",
        "playTime":3,
        "data":" userdata ",
    }
}

XML 示例

XML 示例 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
    <appId>247e35ff320a4142a105024055c367cf </appId>
    <callId>2015100817062901467CTI</callId>
    <fileName>FILE_ID</fileName>
    <playTime>3</playTime>
    <data>userdata</data>
</ivr>

播放TTS对象

属性 类型 约束 说明
ivr appId String 必选 应用唯一标识
callId String 必选 呼叫ID
voiceStr String 必选 TTS文本，不能超过128个字符
playTime int 必选 最多播放次数 (> 0)
data String 可选 用户数据

JSON 示例

JSON 示例 

{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "voiceStr":"您的短信剩余15条",
        "playTime":3,
        "data":" userdata ",
    }
}

XML 示例

XML 示例 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
    <appId>247e35ff320a4142a105024055c367cf </appId>
    <callId>2015100817062901467CTI</callId>
    <voiceStr>您的短信剩余15条</voiceStr>
    <playTime>3</playTime>
    <data>userdata</data>
</ivr>

一般响应对象

属性 类型 约束 说明
resp respCode String 必选 参见 响应码说明
ivr appId String 必选 应用ID
callId String 必选 呼叫ID

JSON示例

JSON示例 

{
    "resp": {
        "respCode": "000000",
        "ivr": {
            "appId": "8230e48a30864a50a5ad5919d0b30dd1",
            "callId":"2015102614502300261CTI"
        }
    }
}

XML示例

XML示例 

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<resp>
    <respCode>000000</respCode>
    <ivr>
        <appId>8230e48a30864a50a5ad5919d0b30dd1</appId>
        <callId>2015102614502300261CTI</callId>
    </ivr>
</resp>

接口说明

获取DTMF

功能 获取用户按键
URL https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/service/dtmf?sig={SigParameter}
Method POST
Headers 参考REST介绍中 HTTP Headers 的说明
Body 获取DTMF对象
Response 一般响应对象

播放语音

功能 播放语音
URL https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/play?sig={SigParameter}
Method POST
Headers 参考REST介绍中 HTTP Headers 的说明
Body 播放语音对象
Response 一般响应对象

播放TTS

功能 播放TTS
URL https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/playTts?sig={SigParameter}
Method POST
Headers 参考REST介绍中 HTTP Headers 的说明
Body 播放TTS对象
Response 一般响应对象