“外呼任务”的版本间的差异

来自uucall
跳转至： 导航、 搜索
第58行： 第58行：
 
|}
 
|}
  
−
返回值格式:
+
=== 返回值格式 ===
 
application/json
 
application/json
  
第121行： 第121行：
  
 
== 查询项目 ==
 
== 查询项目 ==
 +
=== 说明 ===
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/project/forcast<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
GET cti/project/forcast 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 || Long ||
 +
|-
 +
| 输入参数 || projectID || 项目id || true || Long ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 项目json格式数据 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 创建IVR外呼项目 ==
 
== 创建IVR外呼项目 ==
 +
=== 说明 ===
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/project/ivr<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
GET cti/project/ivr 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 || Long ||
 +
|-
 +
| 输入参数 || name || ivr外呼项目名称 || true || Long ||
 +
|-
 +
| 输入参数 || istimer || 是否定时播报1为立即播报，2为定时播报 || false || Long ||
 +
|-
 +
| 输入参数 || timezone || 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd || false || Long ||
 +
|-
 +
| 输入参数 || diynum || 外显号码 || true || Long ||
 +
|-
 +
| 输入参数 || IvrName || ivr名称 || true || Long ||
 +
|-
 +
| 输入参数 || line || 外拨线路数 || false || Long ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 项目json格式数据 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 修改IVR外呼项目 ==
 
== 修改IVR外呼项目 ==
 +
=== 说明 ===
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/{uid}/project/ivr/{projectId}<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
GET cti/1225/project/ivr/1006 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 || Long ||
 +
|-
 +
| 输入参数 || name || ivr外呼项目名称 || true || Long ||
 +
|-
 +
| 输入参数 || istimer || 是否定时播报1为立即播报，2为定时播报 || false || Long || 1
 +
|-
 +
| 输入参数 || timezone || 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd || false || Long ||
 +
|-
 +
| 输入参数 || diynum || 外显号码 || true || Long ||
 +
|-
 +
| 输入参数 || IvrName || ivr名称 || true || Long ||
 +
|-
 +
| 输入参数 || line || 外拨线路数 || false || Long || 10
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 创建一键外呼项目 ==
 
== 创建一键外呼项目 ==
 +
=== 说明 ===
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/project/onekey<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
GET cti/project/onekey 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 || Long ||
 +
|-
 +
| 输入参数 || name || 一键外呼项目名称 || true || Long ||
 +
|-
 +
| 输入参数 || istimer || 是否定时播报1为立即播报，2为定时播报 || false || Long || 1
 +
|-
 +
| 输入参数 || timezone || 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd || false || Long ||
 +
|-
 +
| 输入参数 || diynum || 外显号码 || true || Long ||
 +
|-
 +
| 输入参数 || extname || 队列名称 || true || Long ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 修改一键外呼项目 ==
 
== 修改一键外呼项目 ==
 +
=== 说明 ===
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/{uid}/project/onekey/{projectId}<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
GET cti/1225/project/onekey/1006 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 || Long ||
 +
|-
 +
| 输入参数 || projectID || 项目id || true || Long ||
 +
|-
 +
| 输入参数 || name || 一键外呼项目名称 || false || String ||
 +
|-
 +
| 输入参数 || istimer || 是否定时播报1为立即播报，2为定时播报 || false || int ||
 +
|-
 +
| 输入参数 || timezone || 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd || false || String ||
 +
|-
 +
| 输入参数 || diynum || 外显号码 || false || String ||
 +
|-
 +
| 输入参数 || extname || 队列名称 || false || String ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 启动或者暂停项目状态 ==
 
== 启动或者暂停项目状态 ==
 +
=== 说明 ===
 +
方法: PUT<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/{uid}/project/{projectID}<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
GET cti/1225/project/1006 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 || Long ||
 +
|-
 +
| 输入参数 || projectID || 项目id || true || Long ||
 +
|-
 +
| 输入参数 || state || state:2---启动  3:---暂停  当前只能传  2 或者3  不是的话就 返回 || true || int ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 删除项目 ==
 
== 删除项目 ==
 +
=== 说明 ===
 +
方法: DELETE<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/{uid}/project/{projectID}<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
DELETE cti/1225/project/1006 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 || Long ||
 +
|-
 +
| 输入参数 || projectID || 项目id || true || Long ||
 +
|-
 +
| 输入参数 || state || state:2---启动  3:---暂停  当前只能传  2 或者3  不是的话就 返回 || true || int ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 项目列表分页查询 ==
 
== 项目列表分页查询 ==
 +
=== 说明 ===
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/project<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
GET cti/project 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 || Long ||
 +
|-
 +
| 输入参数 || name || 项目名称 || false || String ||
 +
|-
 +
| 输入参数 || type || (1 - 预测外呼;2-ivr外呼; 4 - 一键外呼) || false || int ||
 +
|-
 +
| 输入参数 || state || (1.新建2.启动,3暂停,4完成) || false || Long ||
 +
|-
 +
| 输入参数 || startTime || 开始时间格式"yyyy-MM-dd HH:mm:ss"，例如：2016-01-01 00:00:00 || false || String ||
 +
|-
 +
| 输入参数 || endTime || 结束时间格式"yyyy-MM-dd HH:mm:ss"，例如：2016-12-31 23:59:59 || false || String ||
 +
|-
 +
| 输入参数 || page || 第几页 大于0，默认1 || false || Long ||
 +
|-
 +
| 输入参数 || pagesize || 一页几行 大于0，最大不能超过100，默认10 || false || Long ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 批次号号码库导入 ==
 
== 批次号号码库导入 ==
 +
=== 说明 ===
 +
方法: POST<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/project/phonebatch<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
POST cti/project/phonebatch 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 || Long ||
 +
|-
 +
| 输入参数 || pid || 项目id || true || String ||
 +
|-
 +
| 输入参数 || batchName || 批次名称 || false || String ||
 +
|-
 +
| 输入参数 || phoneList || 导入号码集合 || true || list ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 改变批次号优先级 ==
 
== 改变批次号优先级 ==
 +
=== 说明 ===
 +
方法: PUT<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/{uid}/project/phonebatch/{batchId}<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
PUT cti/1225/project/phonebatch/20151127-160407-9 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 || Long ||
 +
|-
 +
| 输入参数 || batchId || 批次号id || true || Long ||
 +
|-
 +
| 输入参数 || priority || 优先级 0-99 || true || Int ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 删除批次号 ==
 
== 删除批次号 ==
 +
=== 说明 ===
 +
方法: DELETE<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/{uid}/project/phonebatch/{batchId}<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
DELETE cti/1225/project/phonebatch/20151127-160407-9 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 || Long ||
 +
|-
 +
| 输入参数 || batchId || 批次号id || true || Long ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />
 +
 
== 批次号分页查询 ==
 
== 批次号分页查询 ==
 +
=== 说明 ===
 +
方法: GET<br />
 +
前缀：http://ip:port/uucall_restapi/rest/
 +
路径: cti/project/phonebatch<br />
 +
参数校验：无
 +
 +
=== 示例 ===
 +
GET cti/project/phonebatch 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 || Long ||
 +
|-
 +
| 输入参数 || pid || 项目id|| true || Long ||
 +
|-
 +
| 输入参数 || name || 批次名称 || false || Long ||
 +
|-
 +
| 输入参数 || numberCount || 号码数量 || false || int ||
 +
|-
 +
| 输入参数 || priority || 优先级 || false || int ||
 +
|-
 +
| 输入参数 || startTime || 开始时间格式"yyyy-MM-dd HH:mm:ss"，例如：2016-01-01 00:00:00 || false || String ||
 +
|-
 +
| 输入参数 || endTime || 结束时间格式"yyyy-MM-dd HH:mm:ss"，例如：2016-12-31 23:59:59 || false || String ||
 +
|-
 +
| 输入参数 || page || 第几页 大于0，默认1 || false || int ||
 +
|-
 +
| 输入参数 || pagesize || 一页几行 大于0，最大不能超过100，默认10 || false || int ||
 +
|-
 +
|}
 +
 +
=== 结构响应 ===
 +
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data !! Code
 +
|-
 +
| success || 成功描述 || 0
 +
|-
 +
| error || sql exception || 4
 +
|-
 +
| error || parameters error || 9
 +
|}
 +
 +
=== 返回值格式 ===
 +
application/json<br />
 +
其中 ivr模板json字符串 形式如下：<br />
 +
<br />
 +
{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]
 +
<br />

2016年4月24日 (日) 17:24的版本

创建预测外呼项目

说明

方法: POST
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/project/forcast
参数校验：无

示例

POST /cti/project/forcast 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":"1225",
   "name": "一键外呼0315",
   "istimer": "2",
   "timezone": "09:00~17:30,01,02,03,04,05",
   "diynum": "4008792831",
   "extname": "1001队列",
   "ext1name": "测试队列"
   "mul": "4"
}


参数列表

类型 参数名 描述 是否必填 数据类型 默认值
输入参数 uid 企业帐号ID true Long
输入参数 name 预测外呼项目名称 true String
输入参数 istimer 是否定时播报1为立即播报，2为定时播报 false Int
输入参数 timezone 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd false String
输入参数 diynum 外显号码 true String
输入参数 ext1name 分机队列名称 true String
输入参数 mul 外呼比例 true Int

结构响应

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

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

返回值格式

application/json

修改预测外呼项目

说明

方法: GET
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/{uid}/project/forcast/{projectId}
参数校验：无

示例

GET /cti/1225/project/forcast/1006 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


参数列表

类型 参数名 描述 是否必填 数据类型 默认值
输入参数 projectId 预测外呼项目Id true Long
输入参数 name 预测外呼项目名称 false String
输入参数 istimer 是否定时播报1为立即播报，2为定时播报 false Int
输入参数 timezone 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd false String
输入参数 diynum 外显号码 false String
输入参数 ext1name 分机队列名称 false String
输入参数 mul 外呼比例 false Int

结构响应

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

Result Data Code
success [ivr模板json字符串,ivr模板json字符串,...] 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

查询项目

说明

方法: GET
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/project/forcast
参数校验：无

示例

GET cti/project/forcast 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 Long
输入参数 projectID 项目id true Long

结构响应

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

Result Data Code
success 项目json格式数据 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

创建IVR外呼项目

说明

方法: GET
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/project/ivr
参数校验：无

示例

GET cti/project/ivr 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 Long
输入参数 name ivr外呼项目名称 true Long
输入参数 istimer 是否定时播报1为立即播报，2为定时播报 false Long
输入参数 timezone 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd false Long
输入参数 diynum 外显号码 true Long
输入参数 IvrName ivr名称 true Long
输入参数 line 外拨线路数 false Long

结构响应

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

Result Data Code
success 项目json格式数据 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

修改IVR外呼项目

说明

方法: GET
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/{uid}/project/ivr/{projectId}
参数校验：无

示例

GET cti/1225/project/ivr/1006 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 Long
输入参数 name ivr外呼项目名称 true Long
输入参数 istimer 是否定时播报1为立即播报，2为定时播报 false Long 1
输入参数 timezone 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd false Long
输入参数 diynum 外显号码 true Long
输入参数 IvrName ivr名称 true Long
输入参数 line 外拨线路数 false Long 10

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

创建一键外呼项目

说明

方法: GET
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/project/onekey
参数校验：无

示例

GET cti/project/onekey 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 Long
输入参数 name 一键外呼项目名称 true Long
输入参数 istimer 是否定时播报1为立即播报，2为定时播报 false Long 1
输入参数 timezone 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd false Long
输入参数 diynum 外显号码 true Long
输入参数 extname 队列名称 true Long

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

修改一键外呼项目

说明

方法: GET
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/{uid}/project/onekey/{projectId}
参数校验：无

示例

GET cti/1225/project/onekey/1006 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 Long
输入参数 projectID 项目id true Long
输入参数 name 一键外呼项目名称 false String
输入参数 istimer 是否定时播报1为立即播报，2为定时播报 false int
输入参数 timezone 定时播报时间区间 格式: HH:mm~HH:mm,dd,dd false String
输入参数 diynum 外显号码 false String
输入参数 extname 队列名称 false String

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

启动或者暂停项目状态

说明

方法: PUT
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/{uid}/project/{projectID}
参数校验：无

示例

GET cti/1225/project/1006 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 Long
输入参数 projectID 项目id true Long
输入参数 state state:2---启动 3:---暂停 当前只能传 2 或者3 不是的话就 返回 true int

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

删除项目

说明

方法: DELETE
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/{uid}/project/{projectID}
参数校验：无

示例

DELETE cti/1225/project/1006 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 Long
输入参数 projectID 项目id true Long
输入参数 state state:2---启动 3:---暂停 当前只能传 2 或者3 不是的话就 返回 true int

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

项目列表分页查询

说明

方法: GET
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/project
参数校验：无

示例

GET cti/project 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 Long
输入参数 name 项目名称 false String
输入参数 type (1 - 预测外呼;2-ivr外呼; 4 - 一键外呼) false int
输入参数 state (1.新建2.启动,3暂停,4完成) false Long
输入参数 startTime 开始时间格式"yyyy-MM-dd HH:mm:ss"，例如：2016-01-01 00:00:00 false String
输入参数 endTime 结束时间格式"yyyy-MM-dd HH:mm:ss"，例如：2016-12-31 23:59:59 false String
输入参数 page 第几页 大于0，默认1 false Long
输入参数 pagesize 一页几行 大于0，最大不能超过100，默认10 false Long

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

批次号号码库导入

说明

方法: POST
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/project/phonebatch
参数校验：无

示例

POST cti/project/phonebatch 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 Long
输入参数 pid 项目id true String
输入参数 batchName 批次名称 false String
输入参数 phoneList 导入号码集合 true list

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

改变批次号优先级

说明

方法: PUT
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/{uid}/project/phonebatch/{batchId}
参数校验：无

示例

PUT cti/1225/project/phonebatch/20151127-160407-9 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 Long
输入参数 batchId 批次号id true Long
输入参数 priority 优先级 0-99 true Int

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

删除批次号

说明

方法: DELETE
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/{uid}/project/phonebatch/{batchId}
参数校验：无

示例

DELETE cti/1225/project/phonebatch/20151127-160407-9 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 Long
输入参数 batchId 批次号id true Long

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

批次号分页查询

说明

方法: GET
前缀：http://ip:port/uucall_restapi/rest/ 路径: cti/project/phonebatch
参数校验：无

示例

GET cti/project/phonebatch 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 Long
输入参数 pid 项目id true Long
输入参数 name 批次名称 false Long
输入参数 numberCount 号码数量 false int
输入参数 priority 优先级 false int
输入参数 startTime 开始时间格式"yyyy-MM-dd HH:mm:ss"，例如：2016-01-01 00:00:00 false String
输入参数 endTime 结束时间格式"yyyy-MM-dd HH:mm:ss"，例如：2016-12-31 23:59:59 false String
输入参数 page 第几页 大于0，默认1 false int
输入参数 pagesize 一页几行 大于0，最大不能超过100，默认10 false int

结构响应

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

Result Data Code
success 成功描述 0
error sql exception 4
error parameters error 9

返回值格式

application/json
其中 ivr模板json字符串 形式如下：

{\"id\":65921,\"uid\":1225,\"createTime\":1450755525,\"rootid\":66822,\"batch\":\"IVR65921\",\"state\":0,\"variables\":\"[IvrVarPair(leftvar:${password}, rigntvar:密码), IvrVarPair(leftvar:${num1}, rigntvar:变量1), IvrVarPair(leftvar:${one}, rigntvar:数据库数据1), IvrVarPair(leftvar:${two}, rigntvar:数据库数据2)]\"}]

取自“http://112.5.128.48:9988/index.php?title=外呼任务&oldid=153”