~~NOTOC~~

======监听======

监听是通话过程中，班长可以听到被监听方坐席的谈话，班长状态也可以通过相关接口进行转换，其中与坐席和用户通话必须有班长监听的前提
  * [[#监听对象| 监听对象]]
  * [[#恢复监听/结束监听对象|恢复监听/结束监听对象]]
  * [[#用户/坐席交谈对象|用户/坐席交谈对象]]
  * [[#强插/强拆对象|强插/强拆对象]]
  * [[#坐席替换对象|坐席替换对象]]
  * [[#一般响应对象|一般响应对象]]
包含以下接口：
  * [[#开始监听|开始监听]]
  * [[#恢复监听|恢复监听]]
  * [[#跟坐席交谈|跟坐席交谈]]
  * [[#跟用户交谈|跟用户交谈]]
  * [[#强插|强插]]
  * [[#强拆|强拆]]
  * [[#坐席替换|坐席替换]]
  * [[#结束监听|结束监听]]



  
===== 数据结构说明 =====
==== 监听对象 ====

{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="14" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|callId
|String
|style="text-align:center;"|必选
|呼叫ID
|-
|number
|String
|style="text-align:center;"|必选
|班长PSTN号码或Client ID
|-
|data
|String
|style="text-align:center;"|可选
|用户透传数据
|}


----


<hidden JSON示例>
<code javascript>
{
    "ivr":{
           "appId":"247e35ff320a4142a105024055c367cf",
           "callId":"77a18fb0-bdde-11e5-b810-77c743ca5c3a",
           "number":"075582255215",
           "data":""
    }
}</code>
</hidden>

----

<hidden XML示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
     <appId>247e35ff320a4142a105024055c367cf</appId>
     <callId>77a18fb0-bdde-11e5-b810-77c743ca5c3a</callId>
     <number>075582255125</number>
     <data></data>
</ivr></code>
</hidden>

----

==== 恢复监听/结束监听对象 ====

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

<hidden JSON示例>
<code javascript>
{
    "ivr":{
          "appId":"247e35ff320a4142a105024055c367cf",
          "callId":"77a18fb0-bdde-11e5-b810-77c743ca5c3a",
          "data":""
    }
}
</code>
</hidden>
----
<hidden XML示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
     <appId>247e35ff320a4142a105024055c367cf</appId>
     <callId>77a18fb0-bdde-11e5-b810-77c743ca5c3a</callId>
     <data></data>
</ivr>
</code>
</hidden>
----
==== 用户/坐席交谈对象 ====

{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="14" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|callId
|String
|style="text-align:center;"|必选
|呼叫ID
|-
|fileName 
|String
|style="text-align:center;"|可选
|与坐席通话前播放的语音文件名，放音文件需要先上传，如不传此参数，则不播放任何内容
|-
|data
|String
|style="text-align:center;"|可选
|用户透传数据
|}

<hidden JSON示例>
<code javascript>
{
    "ivr":{
          "appId":"247e35ff320a4142a105024055c367cf",
          "callId":"77a18fb0-bdde-11e5-b810-77c743ca5c3a",
          "fileName":"",
          "data":""
    }
}
</code>
</hidden>
----
<hidden XML示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
      <appId>247e35ff320a4142a105024055c367cf</appId>
      <callId>77a18fb0-bdde-11e5-b810-77c743ca5c3a</callId>
      <fileName></fileName>
      <data></data>
</ivr>
</code>
</hidden>

----
==== 强插/强拆对象====

{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="14" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|callId
|String
|style="text-align:center;"|必选
|呼叫ID
|-
|number 
|String
|style="text-align:center;"|可选
|班长PSTN号码或Client ID，班长已经监听情况下可选,班长没有监听时需要填写该字段
|-
|fileName
|String
|style="text-align:center;"|可选
|与坐席/用户通话前先播放的文件，要求文件要先上传，如不传此参数则不播放任何内容
|-
|data
|String
|style="text-align:center;"|可选
|用户透传数据
|}

<hidden JSON示例>
<code javascript>
{
    "ivr":{
          "appId":"247e35ff320a4142a105024055c367cf",
          "callId":"77a18fb0-bdde-11e5-b810-77c743ca5c3a",
          "number":"075582255125",
          "fileName":"",
          "data":""
    }
}
</code>
</hidden>
----
<hidden XML示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
       <appId>247e35ff320a4142a105024055c367cf</appId>
       <callId>77a18fb0-bdde-11e5-b810-77c743ca5c3a</callId>
       <number>075582255125</number>
       <fileName></fileName>
       <data></data>
</ivr>
</code>
</hidden>
----
==== 坐席替换对象 ====

{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="14" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|callId
|String
|style="text-align:center;"|必选
|呼叫ID
|-
|number 
|String
|style="text-align:center;"|必选
|坐席PSTN号码或Client ID
|-
|fileName
|String
|style="text-align:center;"|可选
|与坐席通话前播放的语音文件名，放音文件需要先上传，如不传此参数则不播放任何内容
|-
|data
|String
|style="text-align:center;"|可选
|用户透传数据
|}

<hidden JSON示例>
<code javascript>
{
    "ivr":{
           "appId":"247e35ff320a4142a105024055c367cf",
           "callId":"77a18fb0-bdde-11e5-b810-77c743ca5c3a",
           "number":"075582255125",
           "fileName":"",
           "data":""
    }
}
</code>
</hidden>
----
<hidden XML示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
   	<appId>247e35ff320a4142a105024055c367cf</appId>
        <callId>77a18fb0-bdde-11e5-b810-77c743ca5c3a</callId>
        <number>075582255125</number>
        <fileName></fileName>
        <data></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/listening?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
|参考REST介绍中[[..rest_api介绍及接入#统一请求包头 | HTTP Headers ]]的说明
|-
! Body
| [[#监听对象|监听对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}





==== 恢复监听 ====

{| style="width:90%;"
!功能
|班长恢复监听状态
|-
! | URL 
|%%https://api.ucpaas.com/{SoftVersion}/Accounts/{AccountSid}/ipcc/call/recoverListening?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
|参考REST介绍中[[..rest_api介绍及接入#统一请求包头 | HTTP Headers ]]的说明
|-
! Body
| [[#恢复监听/结束监听对象|恢复监听对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}



==== 跟坐席交谈 ====

{| style="width:90%;"
!功能
|班长和坐席说话
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{AccountSid}/ipcc/call/talkToSeat?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
|参考REST介绍中[[..rest_api介绍及接入#统一请求包头 | HTTP Headers ]]的说明
|-
! Body
| [[#用户/坐席交谈对象|坐席交谈对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}


==== 跟用户交谈 ====

{| style="width:90%;" 
!功能
|班长和用户交谈，坐席侧只能听，不能说
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/talkToCustomer?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
|参考REST介绍中[[..rest_api介绍及接入#统一请求包头 | HTTP Headers ]]的说明
|-
! Body
| [[#用户/坐席交谈对象|用户交谈对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}

==== 强插 ====

{| style="width:90%;" 
!功能
|班长强行插入坐席和用户直接通话
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{AccountSid}/ipcc/call/bargeIn?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
|参考REST介绍中[[..rest_api介绍及接入#统一请求包头 | HTTP Headers ]]的说明
|-
! Body
| [[#强插/强拆对象|强插对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}

==== 强拆====

{| style="width:90%;" 
!功能
|班长和用户交谈，坐席侧被挂断
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{AccountSid}/ipcc/call/demolitions?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
|参考REST介绍中[[..rest_api介绍及接入#统一请求包头 | HTTP Headers ]]的说明
|-
! Body
| [[#强插/强拆对象|强拆对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}

==== 坐席替换 ====

{| style="width:90%;" 
!功能
|班长替换坐席，可以用新坐席也可以班长自己替换坐席
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/seatReplace?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
|参考REST介绍中[[..rest_api介绍及接入#统一请求包头 | HTTP Headers ]]的说明
|-
! Body
| [[#坐席替换对象|坐席替换对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}

==== 结束监听 ====

{| style="width:90%;" 
!功能
|班长结束监听
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/call/endListening?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
|参考REST介绍中[[..rest_api介绍及接入#统一请求包头 | HTTP Headers ]]的说明
|-
! Body
| [[#恢复监听/结束监听对象|结束监听对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}