~~NOTOC~~

======呼叫类接口======
呼叫类接口，为用户提供呼叫功能。呼叫中心呼叫类接口主要数据结构有：
  * [[#呼叫应答对象 | 呼叫应答对象]]
  * [[#呼叫转坐席对象 | 呼叫转坐席对象]]
  * [[#入队对象 | 入队对象]]
  * [[#结束呼叫转IVR对象 | 结束呼叫转IVR对象]]
  * [[#结束呼叫对象 | 结束呼叫对象]]
  * [[#预览式外呼对象 | 预览式外呼对象]]
  * [[#预测式外呼对象 | 预测式外呼对象]]   
  * [[#一般响应对象 | 一般响应对象]]
包含以下接口：
  * [[#呼叫应答 | 呼叫应答]] 
  * [[#呼叫转坐席 | 呼叫转坐席]]
  * [[#入队 | 入队]]
  * [[#结束呼叫转IVR | 结束呼叫转IVR]]
  * [[#结束呼叫 | 结束呼叫]]
  * [[#预览式外呼 | 预览式外呼]]
  * [[#预测式外呼 | 预测式外呼]]
  * [[#话单下载 | 话单下载]]
===== 数据结构说明 =====
==== 呼叫应答对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="3" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|callId 
|String 
|style="text-align:center;"|必选
|呼叫ID
|-
|ansCode
|int
|style="text-align:center;"|必选
|呼叫应答方式 0：接听 1：拒绝
|}

----
<hidden JSON 示例>
<code java>
{
    "ivr": {
        "appId": "247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "ansCode":0
    }
}
</code>
</hidden>
----

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

----

==== 呼叫转坐席对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="7" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|callId 
|String 
|style="text-align:center;"|必选
|呼叫ID
|-
|called
|String
|style="text-align:center;"|必选
|sip账号或PSTN号码
|-
|displayNumber
|String
|style="text-align:center;"|可选
|坐席显示号码
|-
|callerFileName
|String
|style="text-align:center;"|可选
|用户侧提示音
|-
|calledFileName
|String
|style="text-align:center;"|可选
|坐席侧提示音，坐席接通后放音
|-
|data
|String
|style="text-align:center;"|可选
|用户透传数据
|}

----
<hidden JSON 示例>
<code java>
{
    "ivr": {
        "appId": "247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "called":"66052154258956",
        "data":""
    }
}
</code>
</hidden>
----

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

----

==== 入队对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="5" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|callId 
|String 
|style="text-align:center;"|必选
|呼叫ID
|-
|queueId
|String
|style="text-align:center;"|必选
|技能组ID, 只能为数字
|-
|prioiServiceId
|String
|style="text-align:center;"|可选
|优先接听坐席ID，为空代表不存在优先接听坐席
|-
|data
|String
|style="text-align:center;"|可选
|用户透传数据
|}

----
<hidden JSON 示例>
<code java>
{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "queueId":"1",
        "prioiServiceId":"",
        "data":" userdata "
    }
}
</code>
</hidden>
----

<hidden XML 示例>
<code 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>
</code>
</hidden>

----
==== 结束呼叫转IVR对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="8" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|callId 
|String 
|style="text-align:center;"|必选
|呼叫ID
|-
|fileName
|String
|style="text-align:center;"|必选
|放音文件名(放音文件已上传)
|-
|playTime
|int
|style="text-align:center;"|必选
|最多播放次数 ，取值大于0
|-
|maxRevCnt
|int
|style="text-align:center;"|必选
|最多收码个数，取值大于等于 0，为0时，key2End不能为空字符
|-
|key2End
|String
|style="text-align:center;"|必选
|收到指定DTMF码后结束收号，不可与maxRevCnt同时无效 (0~9、*、#、空字符)
|-
|spaceTime
|int
|style="text-align:center;"|必选
|最长按键间隔，以秒为单位，取值大于等于 0，为0时代表默认值：30S
|-
|totalTime
|int
|style="text-align:center;"|必选
|最长等待时间，以秒为单位，取值大于等于 0，为0时代表默认值：60S
|}

----
<hidden JSON 示例>
<code java>
{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
        "fileName":"FILE_ID",
        "playTime":3,
        "maxRevCnt":1,
        "key2End":"0",
        "spaceTime":5,
        "totalTime":30,
    }
}

</code>
</hidden>
----

<hidden XML 示例>
<code 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>
</code>
</hidden>

----



==== 结束呼叫对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="2" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|callId 
|String 
|style="text-align:center;"|必选
|呼叫ID
|}

----
<hidden JSON 示例>
<code java>
{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "callId":"2015100817062901467CTI",
    }
}
</code>
</hidden>
----

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

----
==== 预览式外呼对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="9" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|caller 
|String 
|style="text-align:center;"|必选
|主叫号码(sip账号或pstn号码)
|-
|called
|String 
|style="text-align:center;"|必选
|被叫叫号码(sip账号或pstn号码)
|-
|called
|String 
|style="text-align:center;"|必选
|被叫叫号码(sip账号或pstn号码)
|-
|callerFileName
|String
|style="text-align:center;"|可选
|用户侧提示音
|-
|calledFileName
|String
|style="text-align:center;"|可选
|坐席侧提示音，坐席接通后放音
|-
|displayCallerNum
|String
|style="text-align:center;"|可选
|主叫侧显号，手机或固话，号码需要备案才可使用。
|-
|displayCalledNum
|String
|style="text-align:center;"|可选
|被叫侧显号，手机或固话，号码需要备案才可使用。
|-
|data
|String
|style="text-align:center;"|可选
|用户透传数据
|}

----
<hidden JSON 示例>
<code java>
{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "caller":"66170027957964",
        "called":"18888888888",
        "displayCallerNum":"18888888888",
        "displayCalledNum":"18888888888",
        "data":" userdata "
    }
}
</code>
</hidden>
----

<hidden XML 示例>
<code 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>
</code>
</hidden>

----
==== 预测式外呼对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="4" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|queueId 
|String 
|style="text-align:center;"|必选
|呼叫用户后的入队列ID
|-
|caller
|String 
|style="text-align:center;"|必选
|用户号码(PSTN)
|-
|data
|String
|style="text-align:center;"|可选
|用户透传数据
|}

----
<hidden JSON 示例>
<code java>
{
    "ivr":{
        "appId":"247e35ff320a4142a105024055c367cf",
        "queueId":"123",
        "caller":"18888888888",
        "data":" userdata "
    }
}
</code>
</hidden>
----

<hidden XML 示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
    <appId>247e35ff320a4142a105024055c367cf</appId>
    <queueId>123</queueId>
    <caller>18888888888</caller>
    <data>userdata</data>
</ivr>
</code>
</hidden>

----

==== 一般响应对象 ====
{| style="width:90%;"
! colspan="3" | 属性
! 类型
!style="text-align:center;width:3em;"|约束
! 说明
|-
| rowspan="3" style="vertical-align: middle;"| resp
| colspan="2" |respCode
| String
|style="text-align:center;"|必选
|参见[[:呼叫中心:errorcode_ipcc| 响应码说明]]
|-
| rowspan="2" style="vertical-align: middle;"|ivr
|appId
|String
|style="text-align:center;"|必选
|应用ID
|-
|callId
|String
|style="text-align:center;"|必选
|呼叫ID
|}

<hidden JSON示例>
<code javascript>
{
    "resp": {
        "respCode": "000000",
        "ivr": {
            "appId": "8230e48a30864a50a5ad5919d0b30dd1",
            "callId":"2015102614502300261CTI"
        }
    }
}
</code>
</hidden>

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

----

===== 接口说明 =====
==== 呼叫应答 ====
{| style="width:90%;" 
!功能
|对呼叫请求的应答
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/reply?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[# 呼叫应答对象 |  呼叫应答对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}
==== 呼叫转坐席 ====
{| style="width:90%;" 
!功能
|呼叫转坐席
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/callClient?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[# 呼叫转坐席对象 |  呼叫转坐席对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}

==== 入队 ====
{| style="width:90%;" 
!功能
|用户入队
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/queue/enqueue?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc | HTTP Headers ]]的说明
|-
! Body
| [[# 入队对象 |  入队对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}

==== 结束呼叫转IVR ====
{| style="width:90%;" 
!功能
|结束当前通话，转入IVR
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/call2Ivr?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[# 结束呼叫转IVR对象 |  结束呼叫转IVR对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}


==== 结束呼叫 ====
{| style="width:90%;" 
!功能
|结束当前通话
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/disConnect?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc | HTTP Headers ]]的说明
|-
! Body
| [[# 结束呼叫对象 |  结束呼叫对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}

==== 预览式外呼 ====
{| style="width:90%;" 
!功能
|先呼通主叫，再呼通被叫
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/outCall?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[# 预览式外呼对象 |  预览式外呼对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}
==== 预测式外呼 ====
{| style="width:90%;" 
!功能
|呼通用户号码，并入队（确保有空闲坐席）
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/predictOutCall?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[# 预测式外呼对象 |  预测式外呼对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}
==== 话单下载 ====
 参考[[..billlist_api|  应用话单下载]]