用户工具

呼叫中心:呼叫类接口_ipcc

呼叫类接口

数据结构说明

呼叫应答对象

属性 类型 约束 说明
ivr appId String 必选 应用唯一标识
callId String 必选 呼叫ID
ansCode int 必选 呼叫应答方式 0:接听 1:拒绝

JSON 示例

JSON 示例

{
    "ivr": {
        "appId": "247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "ansCode":0
    }
}

XML 示例

XML 示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
   <appId>247e35ff320a4142a105024055c367cf</appId>
   <callId>2015100817062901467CTI</callId>
   <ansCode>0</ansCode>
</ivr>

呼叫转坐席对象

属性 类型 约束 说明
ivr appId String 必选 应用唯一标识
callId String 必选 呼叫ID
called String 必选 sip账号或PSTN号码
displayNumber String 可选 坐席显示号码
callerFileName String 可选 用户侧提示音
calledFileName String 可选 坐席侧提示音,坐席接通后放音
data String 可选 用户透传数据

JSON 示例

JSON 示例

{
    "ivr": {
        "appId": "247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "called":"66052154258956",
        "data":""
    }
}

XML 示例

XML 示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
   <appId>247e35ff320a4142a105024055c367cf</appId>
   <callId>2015100817062901467CTI</callId>
   <called>66052154258956</called>
   <data></data>
</ivr>

入队对象

属性 类型 约束 说明
ivr appId String 必选 应用唯一标识
callId String 必选 呼叫ID
queueId String 必选 技能组ID, 只能为数字
prioiServiceId String 可选 优先接听坐席ID,为空代表不存在优先接听坐席
data String 可选 用户透传数据

JSON 示例

JSON 示例

{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "queueId":"1",
        "prioiServiceId":"",
        "data":" userdata "
    }
}

XML 示例

XML 示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
    <appId>247e35ff320a4142a105024055c367cf</appId>
    <callId>2015092416235200002CTI</callId>
    <queueId>22</queueId>
    <prioiServiceId></prioiServiceId>
    <data>userdata</data> 
</ivr>

结束呼叫转IVR对象

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

JSON 示例

JSON 示例

{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "fileName":"FILE_ID",
        "playTime":3,
        "maxRevCnt":1,
        "key2End":"0",
        "spaceTime":5,
        "totalTime":30,
    }
}

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>
    <maxRevCnt>1</maxRevCnt>
    <key2End>0</key2End>
    <spaceTime>5</spaceTime>
    <totalTime>30</totalTime> 
</ivr>

结束呼叫对象

属性 类型 约束 说明
ivr appId String 必选 应用唯一标识
callId String 必选 呼叫ID

JSON 示例

JSON 示例

{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
    }
}

XML 示例

XML 示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
    <appId>247e35ff320a4142a105024055c367cf </appId>
    <callId>2015100817062901467CTI</callId>
</ivr>

预览式外呼对象

属性 类型 约束 说明
ivr appId String 必选 应用唯一标识
caller String 必选 主叫号码(sip账号或pstn号码)
called String 必选 被叫叫号码(sip账号或pstn号码)
displayCallerNum String 可选 主叫侧显号,手机或固话,号码需要备案才可使用。
displayCalledNum String 可选 被叫侧显号,手机或固话,号码需要备案才可使用。
data String 可选 用户透传数据

JSON 示例

JSON 示例

{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "caller":"66170027957964",
        "called":"18888888888",
        "displayCallerNum":"18888888888",
        "displayCalledNum":"18888888888",
        "data":" userdata "
    }
}

XML 示例

XML 示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
    <appId>247e35ff320a4142a105024055c367cf</appId>
    <caller>66170027957964</caller>
    <called>18888888888</called>
    <displayCallerNum>18888888888</displayCallerNum>
    <displayCalledNum>18888888888</displayCalledNum>
    <data>userdata</data>
</ivr>

预测式外呼对象

属性 类型 约束 说明
ivr appId String 必选 应用唯一标识
queueId String 必选 呼叫用户后的入队列ID
caller String 必选 用户号码(PSTN)
data String 可选 用户透传数据

JSON 示例

JSON 示例

{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "queueId":"123",
        "caller":"18888888888",
        "data":" userdata "
    }
}

XML 示例

XML 示例

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
    <appId>247e35ff320a4142a105024055c367cf</appId>
    <queueId>123</queueId>
    <caller>18888888888</caller>
    <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>

接口说明

呼叫应答

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

呼叫转坐席

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

入队

功能 用户入队
URL https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/queue/enqueue?sig={SigParameter}
Method POST
Headers 参考REST介绍中 HTTP Headers 的说明
Body 入队对象
Response 一般响应对象

结束呼叫转IVR

功能 结束当前通话,转入IVR
URL https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/call2Ivr?sig={SigParameter}
Method POST
Headers 参考REST介绍中 HTTP Headers 的说明
Body 结束呼叫转IVR对象
Response 一般响应对象

结束呼叫

功能 结束当前通话
URL https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/disConnect?sig={SigParameter}
Method POST
Headers 参考REST介绍中 HTTP Headers 的说明
Body 结束呼叫对象
Response 一般响应对象

预览式外呼

功能 先呼通主叫,再呼通被叫
URL https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/outCall?sig={SigParameter}
Method POST
Headers 参考REST介绍中 HTTP Headers 的说明
Body 预览式外呼对象
Response 一般响应对象

预测式外呼

功能 呼通用户号码,并入队(确保有空闲坐席)
URL https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/predictOutCall?sig={SigParameter}
Method POST
Headers 参考REST介绍中 HTTP Headers 的说明
Body 预测式外呼对象
Response 一般响应对象

话单下载

最后更改: 2016/12/24 18:50

页面工具