~~NOTOC~~
======座席管理======
坐席管理是针对一系列IVR坐席的管理接口。
在设计时,需要针对坐席与client子账号做1对1的对应关系,不允许坐席与client账户有多对多或者1对多的对应关系
坐席管理有以下数据结构:
* [[#坐席对象| 坐席对象]]
* [[#签出对象 | 签出对象]]
* [[#查询对象 | 查询对象]]
* [[#查询多个对象 | 查询多个对象]]
* [[#接听方式对象 | 接听方式对象]]
* [[#坐席状态对象 | 坐席状态对象]]
* [[#一般响应返回 | 一般响应返回]]
包含以下接口:
* [[#坐席签入| 坐席签入]]
* [[#坐席签出| 坐席签出]]
* [[#设置坐席接听方式| 设置坐席接听方式]]
* [[#设置坐席状态| 设置坐席状态]]
* [[#查询坐席状态| 查询坐席状态]]
* [[#查询所有坐席状态| 查询所有坐席状态]]
===== 数据结构 =====
==== 坐席对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="8" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|serviceId
|String
|style="text-align:center;"|必选
|必选 坐席ID,32位以内,由用户设置,应用内唯一
|-
|serviceAbility
|Int
|style="text-align:center;"|必选
|坐席能力值0~9,取值越小,优先级越高
|-
|phone
|String
|style="text-align:center;"|必选
|坐席对应的电话号码,当坐席选择接听方式为pstn时,则会呼叫该号码。
|-
|ipAcct
|String
|style="text-align:center;"|必选
|坐席关联的client子账号
|-
|curMethod
|Int
|style="text-align:center;"|必选
|当前接听方式 0: IP 1: phone
|-
|skill
|String
|style="text-align:center;"|必选
|所签入的队列号,多个队列号之间由”,”隔开,字符串最多支持128个字节
|-
|state
|Int
|style="text-align:center;"|必选
|签入时坐席的状态。取值大于等于0,0置闲,非0置忙;当坐席为忙时,不会转接通话到坐席。
|}
----
{
"ivr": {
"appId": "247e35ff320a4142a105024055c367cf",
"serviceId": "2",
"serviceAbility": 1,
"phone": "15889963325",
"ipAcct": "66807000020828",
"curMethod": 0,
"skill": "8",
"state": 0
}
}
----
247e35ff320a4142a105024055c367cf
2
1
15889963325
66807000020828
0
8
0
----
==== 签出对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="3" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|serviceId
|String
|style="text-align:center;"|必选
|必选 坐席ID,32位以内
|-
|queueId
|String
|style="text-align:center;"|可选
|所签出的队列号,多个队列号之间由”,”隔开;’字符串最多支持128个字节。如果不传该字段,则签出所有该坐席签入过的技能组
|}
----
{
"ivr": {
"appId": "247e35ff320a4142a105024055c367cf",
"serviceId": "2",
"queueId": "8"
}
}
----
247e35ff320a4142a105024055c367cf
2
8
----
==== 查询对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="3" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|serviceId
|String
|style="text-align:center;"|必选
|必选 坐席ID,32位以内
|}
----
{
"ivr": {
"appId": "247e35ff320a4142a105024055c367cf",
"serviceId": "2",
}
}
----
247e35ff320a4142a105024055c367cf
2
----
==== 查询多个对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="4" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|startServiceId
|String
|style="text-align:center;"|可选
|起始坐席ID,如果为空,从第一个开始查询
|-
|option
|Int
|style="text-align:center;"|可选
|查询选择,根据选项来返回;为空, 查询所有坐席(0: 查询所有坐席 1:查询所有闲坐席 2:查询所有忙坐席
|-
|queryNum
|Int
|style="text-align:center;"|可选
|一次查询数量, 如果为空则返回50个坐席,分页查询最多支持返回200个
|}
----
{
"ivr": {
"appId": "247e35ff320a4142a105024055c367cf",
"option":1,
"startServiceId":"",
"queryNum":100
}
}
----
247e35ff320a4142a105024055c367cf
100
----
==== 接听方式对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="3" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|serviceId
|String
|style="text-align:center;"|必选
|必选 坐席ID,32位以内
|-
|curMethod
|Int
|style="text-align:center;"|必选
|当前接听方式 0: IP 1: phone
|}
----
{
"ivr": {
"appId": "247e35ff320a4142a105024055c367cf",
"serviceId": "2",
"curMethod": "0"
}
}
----
247e35ff320a4142a105024055c367cf
2
0
----
==== 坐席状态对象 ====
{| style="width:90%;"
! colspan="2"|属性
! |类型
!style="text-align:center;width:3em;"|约束
! |说明
|-
|rowspan="3" style="vertical-align: middle;" | ivr
|appId
|String
|style="text-align:center;"|必选
|应用唯一标识
|-
|serviceId
|String
|style="text-align:center;"|必选
|必选 坐席ID,32位以内
|-
|state
|Int
|style="text-align:center;"|必选
|签入时坐席的状态。取值大于等于0,0为闲,非0即为忙。当坐席为忙时,不会转接通话到坐席。
|}
----
{
"ivr": {
"appId": "247e35ff320a4142a105024055c367cf",
"serviceId": "2",
"state": "0"
}
}
----
247e35ff320a4142a105024055c367cf
2
0
----
==== 一般响应对象 ====
{| style="width:90%;"
! colspan="3"|属性
! |类型
! |说明
|-
|rowspan="2" style="vertical-align: middle;" | resp
|respCode
|
|int
|参见[[:呼叫中心:errorcode_ipcc| 响应码说明]]
|-
|rowspan="2" style="vertical-align: middle;"| ivr
|appId
|string
|所属appid
|}
----
{
"resp": {
"respCode": "000000",
"ivr": {
"appId": "8230e48a30864a50a5ad5919d0b30dd1"
}
}
}
----
000000
8230e48a30864a50a5ad5919d0b30dd1
=====接口说明=====
==== 坐席签入 ====
{| style="width:90%;"
!功能
|签入到相应的技能组队列后,该坐席就可以服务于某一个技能组。
|-
! | URL
| %% https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/service/on?sig={SigParameter}%%
|-
! |Method
|POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[#坐席对象| 坐席对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}
----
==== 坐席签出 ====
{| style="width:90%;"
!功能
|从某个技能组队列中退出。停止为签出的技能组服务
|-
! | URL
| %% https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/service/off?sig={SigParameter}%%
|-
! |Method
|POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[#签出对象| 签出对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}
----
==== 设置坐席接听方式 ====
{| style="width:90%;"
!功能
|修改坐席的接听方式。可以为IP电话,固话、手机
|-
! | URL
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/service/setMode?sig={SigParameter}%%
|-
! |Method
|POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[#接听方式对象| 接听方式对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}
----
==== 设置坐席状态 ====
{| style="width:90%;"
!功能
|修改坐席的忙闲状态。坐席状态为0时,队列中的新通话会转接到该坐席;坐席状态为非0时,队列中的新通话不会转到该坐席;该状态值,可以通过 [[# 查询坐席状态 | 查询坐席状态]]获得
|-
! | URL
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/service/setStatus?sig={SigParameter}%%
|-
! |Method
|POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[#坐席状态对象| 坐席状态对象]]
|-
! Response
| [[#一般响应对象| 一般响应对象]]
|}
----
==== 查询坐席状态 ====
{| style="width:90%;"
!功能
|查询坐席的忙或闲状态
|-
! | URL
| %%https://api.ucpaas.com/{SoftVersion}/Accounts/{accountSid}/ipcc/service/status?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/service/statusall?sig={SigParameter}%%
|-
! |Method
|POST
|-
! |Headers
| 参考REST介绍中[[呼叫中心:rest_ipcc| HTTP Headers ]]的说明
|-
! Body
| [[#查询多个对象| 查询多个对象]]
|-
! Response
|rsp对象 : {"rsp":{"respCode":"000000",[[#坐席对象 | 坐席对象]]}}
|}
----