~~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;"|必选
|应用唯一标识
|-
|queueId
|String
|style="text-align:center;"|必选
|技能组ID > 0，只能为数字
|-
|maxQNum
|Int
|style="text-align:center;"|必选
|技能组大小，代表最多可排队的用户个数，为0时代表不做限制
|-
|fileName
|String
|style="text-align:center;"|可选
|入队后默认的放音文件名，放音文件需要先上传，若不传此参数，则播放系统默认的放音文件
|-
|key2ExitQ
|String
|style="text-align:center;"|必选
|按指定键退出排队，为空时代表不提供退出排队的功能，取值：0~9、*、#、空，不可与key2Continue取相同值
|-
|waitTimeLen
|Int
|style="text-align:center;"|必选
|等待超时时长
|-
|timeOutFileName
|String
|style="text-align:center;"|可选
|超时放音文件名，放音文件需要先上传，如果不传此参数则播放默认的音乐，使用默认文件的情况下，请设置按*继续排队按#退出，和默认语音文件提示保持一致。
|-
|key2Continue
|String
|style="text-align:center;"|必选
|按指定键继续等待，为空时代表不提供继续等待功能，取值：0~9、*、#、空，不可与key2ExitQ取相同值
|-
|maxQCnt
|Int
|style="text-align:center;"|必选
|用户最多可排队的次数，等待超时后用户选择继续等待的次数，为0时代表可无限排队
|-
|voiceStr
|String
|style="text-align:center;"|可选
|接通后播放提示音，空则不播放，此处为混合音，为坐席ID+放音文件,坐席ID即工号，只支持两个文件
|-
|strategy
|Int
|style="text-align:center;"|可选
|队列策略类型，呼叫转坐席时,用于查找和呼叫坐席。用户不填默认记忆轮转（1 : 记忆轮转 2: 线性振铃 3: 优先级 4: 最小次数（日）5: 最小次数（月）6：最长空闲）默认为：1
|-
|noAnsSetFree
|Int
|style="text-align:center;"|可选
|坐席没有接听后是否自动置闲选项，可选填（-1 : 不置闲 0-600:表示延迟置闲时间（s））默认为：-1
|-
|callOverSetFree
|Int
|style="text-align:center;"|可选
|坐席挂机后是否自动置闲选项，可选填（-1 : 不置闲 0-600:表示延迟置闲时间（s））默认为：-1
|-
|sequenceSwi
|Int
|style="text-align:center;"|可选
|是否开启顺振模式（0 关闭顺振 1 开启顺振）默认为：0
|}


----


<hidden JSON示例>
<code javascript>
{
    "ivr": {
        "appId": "247e35ff320a4142a105024055c367cf",
        "queueId": "1",
        "maxQNum": 20,
        "fileName": "yzx_queue1.wav",
        "key2ExitQ": "0",
        "waitTimeLen": 20,
        "timeOutFileName": "yzx_queue_busy.wav",
        "key2Continue": "1",
        "maxQCnt": 2,
        "voiceStr": "yzx_fuwu.wav",
        "strategy": 1,
        "noAnsSetFree": 0,
        "callOverSetFree": 0,
        "sequenceSwi": 0
    }
}</code>
</hidden>

----

<hidden XML示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
   <appId>247e35ff320a4142a105024055c367cf</appId>
   <queueId>1</queueId>
   <maxQNum>20</maxQNum>
   <fileName>yzx_queue1.wav</fileName>
   <key2ExitQ>0</key2ExitQ>
   <waitTimeLen>20</waitTimeLen>
   <timeOutFileName>yzx_queue_busy.wav</timeOutFileName>
   <key2Continue>1</key2Continue>
   <maxQCnt>2</maxQCnt>
   <voiceStr>yzx_fuwu.wav</voiceStr>
   <strategy></strategy>
   <noAnsSetFree></noAnsSetFree>
   <callOverSetFree></callOverSetFree>
   <sequenceSwi></sequenceSwi>
</ivr></code>
</hidden>

----


----

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

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

----
<hidden XML示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<resp>
    <respCode>000000</respCode>
    <ivr>
        <appId>8230e48a30864a50a5ad5919d0b30dd1</appId>
    </ivr>
</resp></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;"|必选
|应用唯一标识
|-
|queueId
|String
|style="text-align:center;"|必选
|技能组ID > 0，只能为数字
|}

<hidden JSON示例>
<code javascript>
{
    "ivr":{
        "appId":"8230e48a30864a50a5ad5919d0b30dd1",
        "queueId":"10"
    }
}
</code>
</hidden>
----
<hidden XML示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ivr>
    <appId>8230e48a30864a50a5ad5919d0b30dd1</appId>
    <queueId>10</queueId>
</ivr>
</code>
</hidden>

----

==== 技能组查询排队数对象 ====

{| style="width:90%;"
! colspan="3"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="5" style="vertical-align: middle;" | resp
|rowspan="3" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|queueId
|Int
|style="text-align:center;"|必选
|技能组ID > 0，只能为数字
|-
|count
|Int
|style="text-align:center;"|必选
|队列排队数量
|-
|respCode
|
|Int
|style="text-align:center;"|必选
|REST响应结果
|}

<hidden JSON示例>
<code javascript>
   "resp": {
                "respCode": "000000",
                "ivr":{
	                "appId":"e26d1638401349a0b7f7040fe9760a12",
	                 "queueId": 22,
                         "count":2,
                 }
    }
</code>
</hidden>
----
<hidden XML示例>
<code xml>
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<resp>
         <respCode>000000</respCode>
         <ivr>
	        <appId>e26d1638401349a0b7f7040fe9760a12</appId>
                <queueId>22</queueId>
                <count>2</count>
        </ivr>
</resp>
</code>
</hidden>
----
===== 接口说明 =====
==== 创建技能组 ====
{| style="width:90%;" 
!功能
|创建一个新的技能组
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/queue/create?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/edit?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/del?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/get?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[#技能组查询对象|技能组查询对象]]
|-
! Response
| rsp对象 : {"rsp":{"respCode":"000000",[[#技能组对象 | 技能组对象]]}}
|}

==== 查询技能组排队数 ====

{| style="width:90%;" 
!功能
|查询技能组呼叫排队数量
|-
! | URL 
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/queue/statisticUserAmount?sig={SigParameter}%%
|-
! |Method
| POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc | HTTP Headers ]]的说明
|-
! Body
| [[#技能组查询对象|技能组查询对象]]
|-
! Response
| rsp对象 : {"rsp":{"respCode":"000000",[[#技能组查询排队数对象 | 技能组查询排队数对象]]}}
|}