“分机/队列管理”的版本间的差异

来自uucall
跳转至: 导航搜索
获取分机信息
第1行: 第1行:
 
== 获取分机信息 ==
 
== 获取分机信息 ==
 
=== 说明 ===
 
=== 说明 ===
方法: POST<br />
+
方法: GET<br />
 
前缀:http://ip:port/uucall_restapi/rest/
 
前缀:http://ip:port/uucall_restapi/rest/
路径: cti/userext<br />
+
路径: /cti/userext/{extid}<br />
 
参数校验:无
 
参数校验:无
  
 
=== 示例 ===  
 
=== 示例 ===  
  GET /cti/userext?uid=1225 HTTP/1.1
+
  GET /cti/userext/1001 HTTP/1.1
 
  Host:192.168.2.1:2888
 
  Host:192.168.2.1:2888
 
  content-length: 139
 
  content-length: 139
第22行: 第22行:
 
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 
|-
 
|-
| 查询参数 || uid || 企业帐号ID || true || Long ||  
+
| 查询参数 || uid || 企业帐号ID || true || Int64 ||
 +
|-
 +
| 查询参数 || extid || 分机编号 || true || Int64 ||  
 
|}
 
|}
  
 
=== 结构响应 ===
 
=== 结构响应 ===
 
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
{| class="UserExt"
+
{| class="wikitable"
 
|-
 
|-
 
! Result !! Data
 
! Result !! Data
 
|-
 
|-
| success || 成功描述
+
| success || UserExt
 
|-
 
|-
 
| failed || 失败描述
 
| failed || 失败描述
 
|}
 
|}
  
返回值格式:
+
=== 返回值格式 ===
 
application/json
 
application/json
  
 
== 修改分机信息 ==
 
== 修改分机信息 ==
== 获取队列信息 ==
+
=== 说明 ===
== 修改队列信息 ==
+
方法: PUT<br />
== 新增队列信息 ==
+
前缀:http://ip:port/uucall_restapi/rest/
== 删除队列信息 ==
+
路径: /cti/userext/{extid}<br />
 +
参数校验:无
 +
 
 +
=== 示例 ===  
 +
PUT /cti/userext/1001 HTTP/1.1
 +
Host:192.168.2.1:2888
 +
content-length: 139
 +
Accept:application/xml;
 +
Content-Type:application/xml;charset=utf-8;
 +
appid:XXXX
 +
timestamp:2016-03-11 00:00:00
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 +
<br />
 +
 
 +
=== 参数列表 ===
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 查询参数 || uid || 企业帐号ID || true || Int64 ||
 +
|-
 +
| 查询参数 || extid || 分机编号 || true || Int64 ||
 +
|-
 +
| 查询参数 || bindPhone || 绑定固话/手机 || true || string ||
 +
|-
 +
| 查询参数 || offline || 是否下线转接 1不转接 2转接 || false || boolean ||
 +
|-
 +
| 查询参数 || diyNum || 分机主叫号码 || false || string ||
 +
|-
 +
| 查询参数 || permissions || 外呼权限 1呼入 2呼出 3全部 4全无 || false || boolean ||
 +
|-
 +
| 查询参数 || screenWay || 弹屏方式 - other:第三方;none:无弹屏;crm:CRM弹屏; || false || string || 
 +
|-
 +
| 查询参数 || screenURL || 弹屏地址 || false || string || 
 +
|-
 +
| 查询参数 || screenState || 弹屏时机 || false || Int32 || 
 +
|-
 +
| 查询参数 || accounts || 绑定账号 || false || string || 
 +
|}
 +
 
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || 成功描述
 +
|-
 +
| failed || 失败描述
 +
|}
 +
 
 +
=== 返回值格式 ===
 +
application/json
  
== 修改分机信息 ==
 
 
== 获取队列信息 ==
 
== 获取队列信息 ==
 +
=== 说明 ===
 +
方法: GET<br />
 +
前缀:http://ip:port/uucall_restapi/rest/
 +
路径: /cti/telext/{telextid}<br />
 +
参数校验:无
 +
 +
=== 示例 ===
 +
GET /cti/telext/1888 HTTP/1.1
 +
Host:192.168.2.1:2888
 +
content-length: 139
 +
Accept:application/xml;
 +
Content-Type:application/xml;charset=utf-8;
 +
appid:XXXX
 +
timestamp:2016-03-11 00:00:00
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 +
<br />
 +
 +
=== 参数列表 ===
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 查询参数 || uid || 企业帐号ID || true || Int64 ||
 +
|-
 +
| 查询参数 || telextid || 队列编号 || true || Int64 || 
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || TelExt
 +
|-
 +
| failed || 失败描述
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json
 +
 
== 修改队列信息 ==
 
== 修改队列信息 ==
 +
=== 说明 ===
 +
方法: PUT<br />
 +
前缀:http://ip:port/uucall_restapi/rest/
 +
路径: /cti/telext/{telextid}<br />
 +
参数校验:无
 +
 +
=== 示例 ===
 +
PUT /cti/telext/1001 HTTP/1.1
 +
Host:192.168.2.1:2888
 +
content-length: 139
 +
Accept:application/xml;
 +
Content-Type:application/xml;charset=utf-8;
 +
appid:XXXX
 +
timestamp:2016-03-11 00:00:00
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 +
<br />
 +
 +
=== 参数列表 ===
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 查询参数 || telextid || 队列编号 || true || Int64 ||
 +
|-
 +
| 查询参数 || uid || 用户编号 || true || Int64 ||
 +
|-
 +
| 查询参数 || name || 队列名称 || false || string ||
 +
|-
 +
| 查询参数 || mxwait || 最大等待数 || false || Int32 ||
 +
|-
 +
| 查询参数 || wtmusic || 等待音乐路径 || false || string ||
 +
|-
 +
| 查询参数 || isloop || 是否循环 || false || boolean ||
 +
|-
 +
| 查询参数 || wtsound || 等待提示音路径 || false || string || 
 +
|-
 +
| 查询参数 || interval || 提示间隔 0~60s || false || Int32 || 
 +
|-
 +
| 查询参数 || rule || 转接规则(0转队列 1转分机 2转语音导航 3转固定号码) || false || Int32 || 
 +
|-
 +
| 查询参数 || ring || 是否振铃 || false || boolean || 
 +
|-
 +
| 查询参数 || report || 是否接通报工号 || false || boolean ||
 +
|-
 +
| 查询参数 || states || 分机不可用状态(1通话中 2振铃 4帐号签出) || false || Int64 ||
 +
|-
 +
| 查询参数 || listTimeOut || 队列超时时间 || false || Int32 ||
 +
|-
 +
| 查询参数 || extTimeOut || 分机超时时间 || false || Int32 ||
 +
|-
 +
| 查询参数 || screenWay || 弹屏方式 - none:无弹屏;ext:分机默认弹屏;specify:指定弹屏; || false || Int32 ||
 +
|-
 +
| 查询参数 || screenType || 弹屏类型 - 当screenWay为specify时比传,other:指定第三方弹屏;crm:指定CRM弹屏 || false || Int32 ||
 +
|-
 +
| 查询参数 || screenURL || 弹屏地址 - 当弹屏类型是CRM弹屏时,地址为crmid|pageid(CRM编号和详情页编号用|分隔) || false || string ||
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || 成功描述
 +
|-
 +
| failed || 失败描述
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json
 +
 
== 新增队列信息 ==
 
== 新增队列信息 ==
 +
=== 说明 ===
 +
方法: POST<br />
 +
前缀:http://ip:port/uucall_restapi/rest/
 +
路径: /crm/field/business<br />
 +
参数校验:无
 +
 +
=== 示例 ===
 +
POST /crm/field/business HTTP/1.1
 +
Host:192.168.2.1:2888
 +
content-length: 139
 +
Accept:application/xml;
 +
Content-Type:application/xml;charset=utf-8;
 +
appid:XXXX
 +
timestamp:2016-03-11 00:00:00
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 +
<br />
 +
 +
=== 参数列表 ===
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 查询参数 || uid || 用户编号 || true || Int64 ||
 +
|-
 +
| 查询参数 || name || 队列名称 || false || string ||
 +
|-
 +
| 查询参数 || mxwait || 最大等待数 || false || Int32 ||
 +
|-
 +
| 查询参数 || wtmusic || 等待音乐路径 || false || string ||
 +
|-
 +
| 查询参数 || isloop || 是否循环 || false || boolean ||
 +
|-
 +
| 查询参数 || wtsound || 等待提示音路径 || false || string || 
 +
|-
 +
| 查询参数 || interval || 提示间隔 0~60s || false || Int32 || 
 +
|-
 +
| 查询参数 || rule || 转接规则(0转队列 1转分机 2转语音导航 3转固定号码) || false || Int32 || 
 +
|-
 +
| 查询参数 || ring || 是否振铃 || false || boolean || 
 +
|-
 +
| 查询参数 || report || 是否接通报工号 || false || boolean ||
 +
|-
 +
| 查询参数 || states || 分机不可用状态(1通话中 2振铃 4帐号签出) || false || Int64 ||
 +
|-
 +
| 查询参数 || listTimeOut || 队列超时时间 || false || Int32 ||
 +
|-
 +
| 查询参数 || extTimeOut || 分机超时时间 || false || Int32 ||
 +
|-
 +
| 查询参数 || screenWay || 弹屏方式 - none:无弹屏;ext:分机默认弹屏;specify:指定弹屏; || false || Int32 ||
 +
|-
 +
| 查询参数 || screenType || 弹屏类型 - 当screenWay为specify时比传,other:指定第三方弹屏;crm:指定CRM弹屏 || false || Int32 ||
 +
|-
 +
| 查询参数 || screenURL || 弹屏地址 - 当弹屏类型是CRM弹屏时,地址为crmid|pageid(CRM编号和详情页编号用|分隔) || false || string ||
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || 成功描述
 +
|-
 +
| failed || 失败描述
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json
 +
 
== 删除队列信息 ==
 
== 删除队列信息 ==
 +
=== 说明 ===
 +
方法: DELETE<br />
 +
前缀:http://ip:port/uucall_restapi/rest/
 +
路径: /cti/telext/{telextid}<br />
 +
参数校验:无
 +
 +
=== 示例 ===
 +
DELETE /cti/telext/1888 HTTP/1.1
 +
Host:192.168.2.1:2888
 +
content-length: 139
 +
Accept:application/xml;
 +
Content-Type:application/xml;charset=utf-8;
 +
appid:XXXX
 +
timestamp:2016-03-11 00:00:00
 +
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=
 +
<br />
 +
 +
=== 参数列表 ===
 +
{| class="wikitable"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 查询参数 || uid || 企业帐号ID || true || Int64 ||
 +
|-
 +
| 查询参数 || telextid || 队列编号 || true || Int64 || 
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || TelExt
 +
|-
 +
| failed || 失败描述
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json

2016年4月25日 (一) 09:59的版本

获取分机信息

说明

方法: GET
前缀:http://ip:port/uucall_restapi/rest/ 路径: /cti/userext/{extid}
参数校验:无

示例

GET /cti/userext/1001 HTTP/1.1
Host:192.168.2.1:2888
content-length: 139
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
appid:XXXX
timestamp:2016-03-11 00:00:00
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=


参数列表

类型 参数名 描述 是否必填 数据类型 默认值
查询参数 uid 企业帐号ID true Int64
查询参数 extid 分机编号 true Int64

结构响应

其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:

Result Data
success UserExt
failed 失败描述

返回值格式

application/json

修改分机信息

说明

方法: PUT
前缀:http://ip:port/uucall_restapi/rest/ 路径: /cti/userext/{extid}
参数校验:无

示例

PUT /cti/userext/1001 HTTP/1.1
Host:192.168.2.1:2888
content-length: 139
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
appid:XXXX
timestamp:2016-03-11 00:00:00
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=


参数列表

类型 参数名 描述 是否必填 数据类型 默认值
查询参数 uid 企业帐号ID true Int64
查询参数 extid 分机编号 true Int64
查询参数 bindPhone 绑定固话/手机 true string
查询参数 offline 是否下线转接 1不转接 2转接 false boolean
查询参数 diyNum 分机主叫号码 false string
查询参数 permissions 外呼权限 1呼入 2呼出 3全部 4全无 false boolean
查询参数 screenWay 弹屏方式 - other:第三方;none:无弹屏;crm:CRM弹屏; false string
查询参数 screenURL 弹屏地址 false string
查询参数 screenState 弹屏时机 false Int32
查询参数 accounts 绑定账号 false string

结构响应

其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:

Result Data
success 成功描述
failed 失败描述

返回值格式

application/json

获取队列信息

说明

方法: GET
前缀:http://ip:port/uucall_restapi/rest/ 路径: /cti/telext/{telextid}
参数校验:无

示例

GET /cti/telext/1888 HTTP/1.1
Host:192.168.2.1:2888
content-length: 139
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
appid:XXXX
timestamp:2016-03-11 00:00:00
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=


参数列表

类型 参数名 描述 是否必填 数据类型 默认值
查询参数 uid 企业帐号ID true Int64
查询参数 telextid 队列编号 true Int64

结构响应

其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:

Result Data
success TelExt
failed 失败描述

返回值格式

application/json

修改队列信息

说明

方法: PUT
前缀:http://ip:port/uucall_restapi/rest/ 路径: /cti/telext/{telextid}
参数校验:无

示例

PUT /cti/telext/1001 HTTP/1.1
Host:192.168.2.1:2888
content-length: 139
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
appid:XXXX
timestamp:2016-03-11 00:00:00
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=


参数列表

类型 参数名 描述 是否必填 数据类型 默认值
查询参数 telextid 队列编号 true Int64
查询参数 uid 用户编号 true Int64
查询参数 name 队列名称 false string
查询参数 mxwait 最大等待数 false Int32
查询参数 wtmusic 等待音乐路径 false string
查询参数 isloop 是否循环 false boolean
查询参数 wtsound 等待提示音路径 false string
查询参数 interval 提示间隔 0~60s false Int32
查询参数 rule 转接规则(0转队列 1转分机 2转语音导航 3转固定号码) false Int32
查询参数 ring 是否振铃 false boolean
查询参数 report 是否接通报工号 false boolean
查询参数 states 分机不可用状态(1通话中 2振铃 4帐号签出) false Int64
查询参数 listTimeOut 队列超时时间 false Int32
查询参数 extTimeOut 分机超时时间 false Int32
查询参数 screenWay 弹屏方式 - none:无弹屏;ext:分机默认弹屏;specify:指定弹屏; false Int32
查询参数 screenType 弹屏类型 - 当screenWay为specify时比传,other:指定第三方弹屏;crm:指定CRM弹屏 false Int32
查询参数 screenURL pageid(CRM编号和详情页编号用|分隔) false string

结构响应

其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:

Result Data
success 成功描述
failed 失败描述

返回值格式

application/json

新增队列信息

说明

方法: POST
前缀:http://ip:port/uucall_restapi/rest/ 路径: /crm/field/business
参数校验:无

示例

POST /crm/field/business HTTP/1.1
Host:192.168.2.1:2888
content-length: 139
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
appid:XXXX
timestamp:2016-03-11 00:00:00
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=


参数列表

类型 参数名 描述 是否必填 数据类型 默认值
查询参数 uid 用户编号 true Int64
查询参数 name 队列名称 false string
查询参数 mxwait 最大等待数 false Int32
查询参数 wtmusic 等待音乐路径 false string
查询参数 isloop 是否循环 false boolean
查询参数 wtsound 等待提示音路径 false string
查询参数 interval 提示间隔 0~60s false Int32
查询参数 rule 转接规则(0转队列 1转分机 2转语音导航 3转固定号码) false Int32
查询参数 ring 是否振铃 false boolean
查询参数 report 是否接通报工号 false boolean
查询参数 states 分机不可用状态(1通话中 2振铃 4帐号签出) false Int64
查询参数 listTimeOut 队列超时时间 false Int32
查询参数 extTimeOut 分机超时时间 false Int32
查询参数 screenWay 弹屏方式 - none:无弹屏;ext:分机默认弹屏;specify:指定弹屏; false Int32
查询参数 screenType 弹屏类型 - 当screenWay为specify时比传,other:指定第三方弹屏;crm:指定CRM弹屏 false Int32
查询参数 screenURL pageid(CRM编号和详情页编号用|分隔) false string

结构响应

其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:

Result Data
success 成功描述
failed 失败描述

返回值格式

application/json

删除队列信息

说明

方法: DELETE
前缀:http://ip:port/uucall_restapi/rest/ 路径: /cti/telext/{telextid}
参数校验:无

示例

DELETE /cti/telext/1888 HTTP/1.1
Host:192.168.2.1:2888
content-length: 139
Accept:application/xml;
Content-Type:application/xml;charset=utf-8;
appid:XXXX
timestamp:2016-03-11 00:00:00
Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE=


参数列表

类型 参数名 描述 是否必填 数据类型 默认值
查询参数 uid 企业帐号ID true Int64
查询参数 telextid 队列编号 true Int64

结构响应

其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:

Result Data
success TelExt
failed 失败描述

返回值格式

application/json