查看“文件管理”的源代码

= 文件管理 =
== 文件管理查询 ==
* <big>说明</big>
 方法: GET<br />
 前缀：http://ip:port/uucall_restapi/rest/<br />
 路径: file/data<br />
 参数校验：无

* <big>示例</big>
 GET file/data HTTP/1.1<br />
 Host:192.168.2.1:2888<br />
 content-length: 139<br />
 Accept:application/xml;<br />
 Content-Type:application/xml;charset=utf-8;<br />
 appid:XXXX<br />
 timestamp:2016-03-11 00:00:00<br />
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
<br />

* <big>参数列表</big>
{| class="wikitable"
|-
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
|-
| 输入参数 || uid || 企业帐号ID || true || Long || 
|-
| 输入参数 || page || 第几页 大于0，默认1 || false || int || 
|-
| 输入参数 || pagesize || 一页几行大于0，最大不能超过100，默认10 || false || Int || 
|}
<br />
* <big>结构响应</big>
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
{| class="wikitable"
|-
! Result !! Data !! Code 
|-
| success || list<data> || 0
|-
| error || sql exception || 4
|-
| error || parameters error || 9
|}
<br />
* <big>返回值格式</big>
application/json<br />
其中 ivr模板json字符串 形式如下：<br />
<br />

== 文件上传 ==
* <big>说明</big>
 方法: POST<br />
 前缀：http://ip:port/uucall_restapi/rest/<br />
 路径: file/data<br />
 参数校验：无

* <big>示例</big>
 POST file/data HTTP/1.1<br />
 Host:192.168.2.1:2888<br />
 content-length: 139<br />
 Accept:application/xml;<br />
 Content-Type:application/xml;charset=utf-8;<br />
 appid:XXXX<br />
 timestamp:2016-03-11 00:00:00<br />
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
<br />

* <big>参数列表</big>
{| class="wikitable"
|-
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
|-
| 输入参数 || uid || 企业帐号ID || true || Long || 
|-
| 输入参数 || fileName || 文件名称 || ture || String || 
|-
| 输入参数 || myFile || 上传文件 || false || File || 
|}
<br />
* <big>结构响应</big>
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
{| class="wikitable"
|-
! Result !! Data  
|-
| success || 成功描述
|-
| error || parameters error
|}
<br />
* <big>返回值格式</big>
application/json<br />
其中 ivr模板json字符串 形式如下：<br />
<br />

== 文件下载 ==
* <big>说明</big>
 方法: PUT<br />
 前缀：http://ip:port/uucall_restapi/rest/<br />
 路径: file/{uid}/data<br />
 参数校验：无

* <big>示例</big>
 PUT file/1225/data HTTP/1.1<br />
 Host:192.168.2.1:2888<br />
 content-length: 139<br />
 Accept:application/xml;<br />
 Content-Type:application/xml;charset=utf-8;<br />
 appid:XXXX<br />
 timestamp:2016-03-11 00:00:00<br />
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
<br />

* <big>参数列表</big>
{| class="wikitable"
|-
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
|-
| 输入参数 || uid || 企业帐号ID || true || Long || 
|-
| 输入参数 || fileName || 文件名称 || ture || String || 
|-
| 输入参数 || filePath || 文件路径 || ture || String || 
|}
<br />
* <big>结构响应</big>
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
{| class="wikitable"
|-
! Result !! Data  
|-
| success || 项目json格式数据
|-
| error || parameters error
|}
<br />
* <big>返回值格式</big>
application/json<br />
其中 ivr模板json字符串 形式如下：<br />
<br />

== 文件删除 ==
* <big>说明</big>
 方法: DELETE<br />
 前缀：http://ip:port/uucall_restapi/rest/<br />
 路径: file/{uid}/data<br />
 参数校验：无

* <big>示例</big>
 DELETE file/1225/data HTTP/1.1<br />
 Host:192.168.2.1:2888<br />
 content-length: 139<br />
 Accept:application/xml;<br />
 Content-Type:application/xml;charset=utf-8;<br />
 appid:XXXX<br />
 timestamp:2016-03-11 00:00:00<br />
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
<br />

* <big>参数列表</big>
{| class="wikitable"
|-
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
|-
| 输入参数 || uid || 企业帐号ID || true || Long || 
|-
| 输入参数 || fid || 文件id || ture || String || 
|}
<br />
* <big>结构响应</big>
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
{| class="wikitable"
|-
! Result !! Data  
|-
| success || 项目json格式数据
|-
| error || parameters error
|}
<br />
* <big>返回值格式</big>
application/json<br />
其中 ivr模板json字符串 形式如下：<br />
<br />

== 号码导入到项目的批次中 ==
* <big>说明</big>
 方法: PUT<br />
 前缀：http://ip:port/uucall_restapi/rest/<br />
 路径: file/{uid}/project/{projectId}<br />
 参数校验：无

* <big>示例</big>
 PUT file/1225/project/123 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 />

* <big>参数列表</big>
{| class="wikitable"
|-
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
|-
| 输入参数 || uid || 企业帐号ID || true || Long || 
|-
| 输入参数 || projectId || 所要导入的项目id || ture || String || 
|-
| 输入参数 || importcoll || 表格中的第几列数据导入 || ture || String || 
|-
| 输入参数 || importType || 导入方式 号码去重  1：否 2：是  默认 1 || false || int || 1
|-
| 输入参数 || myFileFileName || 导入的文件名 || ture || String || 
|-
| 输入参数 || uploadnewPath || 导入的文件路径 || ture || String || 
|}
<br />
* <big>结构响应</big>
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
{| class="wikitable"
|-
! Result !! Data  
|-
| success || 项目json格式数据
|-
| error || parameters error
|}
<br />
* <big>返回值格式</big>
application/json<br />
其中 ivr模板json字符串 形式如下：<br />
<br />

== 号码导入到CRM中 ==
* <big>说明</big>
 方法: PUT<br />
 前缀：http://ip:port/uucall_restapi/rest/<br />
 路径: file/{uid}/crm/{crmId}<br />
 参数校验：无

* <big>示例</big>
 PUT file/{uid}/crm/1123 HTTP/1.1<br />
 Host:192.168.2.1:2888<br />
 content-length: 139<br />
 Accept:application/xml;<br />
 Content-Type:application/xml;charset=utf-8;<br />
 appid:XXXX<br />
 timestamp:2016-03-11 00:00:00<br />
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
<br />

* <big>参数列表</big>
{| class="wikitable"
|-
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
|-
| 输入参数 || uid || 企业帐号ID || true || Long || 
|-
| 输入参数 || crmId || 所要导入的CRM id || ture || String || 
|-
| 输入参数 || improtCrmType || 导入方式  1:覆盖已有数据 2:跳过重复数据 || false || String || 1
|-
| 输入参数 || headMap || 导入的数据匹配方式  key=第几列  value=custom_fields.tableField || ture || int || 
|-
| 输入参数 || myFileFileName || 导入的文件名 || ture || String || 
|-
| 输入参数 || uploadnewPath || 导入的文件路径 || ture || String || 
|-
| 输入参数 || createName || 创建者 || ture || String || 
|}
<br />
* <big>结构响应</big>
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
{| class="wikitable"
|-
! Result !! Data  
|-
| success || 成功描述
|-
| error || parameters error
|}
<br />
* <big>返回值格式</big>
application/json<br />
其中 ivr模板json字符串 形式如下：<br />
<br />

= 录音包管理 =
== 录音包管理分页查询 ==
* <big>说明</big>
 方法: GET<br />
 前缀：http://ip:port/uucall_restapi/rest/<br />
 路径: cti/record<br />
 参数校验：无

* <big>示例</big>
 GET cti/record HTTP/1.1<br />
 Host:192.168.2.1:2888<br />
 content-length: 139<br />
 Accept:application/xml;<br />
 Content-Type:application/xml;charset=utf-8;<br />
 appid:XXXX<br />
 timestamp:2016-03-11 00:00:00<br />
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
<br />

* <big>参数列表</big>
{| class="wikitable"
|-
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
|-
| 输入参数 || uid || 企业帐号ID || true || Long || 
|-
| 输入参数 || page || 第几页  大于1，默认1 || ture || String || 
|-
| 输入参数 || pagesize || 一页几行 大于1，最大不能超过100，默认10 || false || String || 
|}
<br />
* <big>结构响应</big>
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
{| class="wikitable"
|-
! Result !! Data  
|-
| success || 成功描述
|-
| error || parameters error
|}
<br />
* <big>返回值格式</big>
application/json<br />
其中 ivr模板json字符串 形式如下：<br />
<br />

== 录音包下载 ==
* <big>说明</big>
 方法: PUT<br />
 前缀：http://ip:port/uucall_restapi/rest/<br />
 路径: cti/{uid}/record<br />
 参数校验：无

* <big>示例</big>
 PUT cti/1225/record HTTP/1.1<br />
 Host:192.168.2.1:2888<br />
 content-length: 139<br />
 Accept:application/xml;<br />
 Content-Type:application/xml;charset=utf-8;<br />
 appid:XXXX<br />
 timestamp:2016-03-11 00:00:00<br />
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
<br />

* <big>参数列表</big>
{| class="wikitable"
|-
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
|-
| 输入参数 || uid || 企业帐号ID || true || Long || 
|-
| 输入参数 || fileName || 文件名称 || ture || String || 
|-
| 输入参数 || filePath || 文件路径 || true || String || 
|}
<br />
* <big>结构响应</big>
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
{| class="wikitable"
|-
! Result !! Data  
|-
| success || 成功描述
|-
| error || parameters error
|}
<br />
* <big>返回值格式</big>
application/json<br />
其中 ivr模板json字符串 形式如下：<br />
<br />

== 录音包删除 ==
* <big>说明</big>
 方法: DELETE<br />
 前缀：http://ip:port/uucall_restapi/rest/<br />
 路径: cti/{uid}/record/{fid}<br />
 参数校验：无

* <big>示例</big>
 DELETE cti/1225/record/1111 HTTP/1.1<br />
 Host:192.168.2.1:2888<br />
 content-length: 139<br />
 Accept:application/xml;<br />
 Content-Type:application/xml;charset=utf-8;<br />
 appid:XXXX<br />
 timestamp:2016-03-11 00:00:00<br />
 Authorization:ZmY4MDgwODEzYzM3ZGE1MzAxM2M4MDRmODA3MjAwN2M6MjAxMzAyMDExNTABCDE<br />
<br />

* <big>参数列表</big>
{| class="wikitable"
|-
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
|-
| 输入参数 || uid || 企业帐号ID || true || Long || 
|-
| 输入参数 || fid || 录音包id || ture || Long || 
|}
<br />
* <big>结构响应</big>
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
{| class="wikitable"
|-
! Result !! Data  
|-
| success || 成功描述
|-
| error || parameters error
|}
<br />
* <big>返回值格式</big>
application/json<br />
其中 ivr模板json字符串 形式如下：<br />
<br />