“文件管理”的版本间的差异
| 第29行： | 第29行： | ||
| 输入参数 || pagesize || 一页几行大于0，最大不能超过100，默认10 || false || Int || | | 输入参数 || pagesize || 一页几行大于0，最大不能超过100，默认10 || false || Int || | ||
|} | |} | ||
| − | + | <br /> | |
* <big>结构响应</big> | * <big>结构响应</big> | ||
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | 其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | ||
| 第42行： | 第42行： | ||
| error || parameters error || 9 | | error || parameters error || 9 | ||
|} | |} | ||
| − | + | <br /> | |
* <big>返回值格式</big> | * <big>返回值格式</big> | ||
application/json<br /> | application/json<br /> | ||
| 第79行： | 第79行： | ||
| 输入参数 || myFile || 上传文件 || false || File || | | 输入参数 || myFile || 上传文件 || false || File || | ||
|} | |} | ||
| − | + | <br /> | |
* <big>结构响应</big> | * <big>结构响应</big> | ||
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | 其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | ||
| 第90行： | 第90行： | ||
| error || parameters error | | error || parameters error | ||
|} | |} | ||
| − | + | <br /> | |
* <big>返回值格式</big> | * <big>返回值格式</big> | ||
application/json<br /> | application/json<br /> | ||
| 第127行： | 第127行： | ||
| 输入参数 || filePath || 文件路径 || ture || String || | | 输入参数 || filePath || 文件路径 || ture || String || | ||
|} | |} | ||
| − | + | <br /> | |
* <big>结构响应</big> | * <big>结构响应</big> | ||
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | 其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | ||
| 第138行： | 第138行： | ||
| error || parameters error | | error || parameters error | ||
|} | |} | ||
| − | + | <br /> | |
* <big>返回值格式</big> | * <big>返回值格式</big> | ||
application/json<br /> | application/json<br /> | ||
| 第173行： | 第173行： | ||
| 输入参数 || fid || 文件id || ture || String || | | 输入参数 || fid || 文件id || ture || String || | ||
|} | |} | ||
| − | + | <br /> | |
* <big>结构响应</big> | * <big>结构响应</big> | ||
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | 其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | ||
| 第184行： | 第184行： | ||
| error || parameters error | | error || parameters error | ||
|} | |} | ||
| − | + | <br /> | |
* <big>返回值格式</big> | * <big>返回值格式</big> | ||
application/json<br /> | application/json<br /> | ||
| 第227行： | 第227行： | ||
| 输入参数 || uploadnewPath || 导入的文件路径 || ture || String || | | 输入参数 || uploadnewPath || 导入的文件路径 || ture || String || | ||
|} | |} | ||
| − | + | <br /> | |
* <big>结构响应</big> | * <big>结构响应</big> | ||
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | 其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | ||
| 第238行： | 第238行： | ||
| error || parameters error | | error || parameters error | ||
|} | |} | ||
| − | + | <br /> | |
* <big>返回值格式</big> | * <big>返回值格式</big> | ||
application/json<br /> | application/json<br /> | ||
| 第283行： | 第283行： | ||
| 输入参数 || createName || 创建者 || ture || String || | | 输入参数 || createName || 创建者 || ture || String || | ||
|} | |} | ||
| − | + | <br /> | |
* <big>结构响应</big> | * <big>结构响应</big> | ||
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | 其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | ||
| 第294行： | 第294行： | ||
| error || parameters error | | error || parameters error | ||
|} | |} | ||
| − | + | <br /> | |
* <big>返回值格式</big> | * <big>返回值格式</big> | ||
application/json<br /> | application/json<br /> | ||
| 第332行： | 第332行： | ||
| 输入参数 || pagesize || 一页几行 大于1，最大不能超过100，默认10 || false || String || | | 输入参数 || pagesize || 一页几行 大于1，最大不能超过100，默认10 || false || String || | ||
|} | |} | ||
| − | + | <br /> | |
* <big>结构响应</big> | * <big>结构响应</big> | ||
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | 其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | ||
| 第343行： | 第343行： | ||
| error || parameters error | | error || parameters error | ||
|} | |} | ||
| − | + | <br /> | |
* <big>返回值格式</big> | * <big>返回值格式</big> | ||
application/json<br /> | application/json<br /> | ||
| 第380行： | 第380行： | ||
| 输入参数 || filePath || 文件路径 || true || String || | | 输入参数 || filePath || 文件路径 || true || String || | ||
|} | |} | ||
| − | + | <br /> | |
* <big>结构响应</big> | * <big>结构响应</big> | ||
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | 其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | ||
| 第391行： | 第391行： | ||
| error || parameters error | | error || parameters error | ||
|} | |} | ||
| − | + | <br /> | |
* <big>返回值格式</big> | * <big>返回值格式</big> | ||
application/json<br /> | application/json<br /> | ||
| 第426行： | 第426行： | ||
| 输入参数 || fid || 录音包id || ture || Long || | | 输入参数 || fid || 录音包id || ture || Long || | ||
|} | |} | ||
| − | + | <br /> | |
* <big>结构响应</big> | * <big>结构响应</big> | ||
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | 其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下： | ||
| 第437行： | 第437行： | ||
| error || parameters error | | error || parameters error | ||
|} | |} | ||
| − | + | <br /> | |
* <big>返回值格式</big> | * <big>返回值格式</big> | ||
application/json<br /> | application/json<br /> | ||
2016年4月25日 (一) 17:05的版本
目录
文件管理
文件管理查询
- 说明
方法: GET
前缀：http://ip:port/uucall_restapi/rest/
路径: file/data
参数校验：无
- 示例
GET file/data 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 | |
| 输入参数 | page | 第几页 大于0，默认1 | false | int | |
| 输入参数 | pagesize | 一页几行大于0，最大不能超过100，默认10 | false | Int |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
| Result | Data | Code |
|---|---|---|
| success | list | 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/
路径: file/data
参数校验：无
- 示例
POST file/data 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 | |
| 输入参数 | fileName | 文件名称 | ture | String | |
| 输入参数 | myFile | 上传文件 | false | File |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
| Result | Data |
|---|---|
| success | 成功描述 |
| error | parameters error |
- 返回值格式
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/
路径: file/{uid}/data
参数校验：无
- 示例
PUT file/1225/data 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 | |
| 输入参数 | fileName | 文件名称 | ture | String | |
| 输入参数 | filePath | 文件路径 | ture | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
| Result | Data |
|---|---|
| success | 项目json格式数据 |
| error | parameters error |
- 返回值格式
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/
路径: file/{uid}/data
参数校验：无
- 示例
DELETE file/1225/data 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 | |
| 输入参数 | fid | 文件id | ture | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
| Result | Data |
|---|---|
| success | 项目json格式数据 |
| error | parameters error |
- 返回值格式
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/
路径: file/{uid}/project/{projectId}
参数校验：无
- 示例
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
- 参数列表
| 类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
|---|---|---|---|---|---|
| 输入参数 | uid | 企业帐号ID | true | Long | |
| 输入参数 | projectId | 所要导入的项目id | ture | String | |
| 输入参数 | importcoll | 表格中的第几列数据导入 | ture | String | |
| 输入参数 | importType | 导入方式 号码去重 1：否 2：是 默认 1 | false | int | 1 |
| 输入参数 | myFileFileName | 导入的文件名 | ture | String | |
| 输入参数 | uploadnewPath | 导入的文件路径 | ture | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
| Result | Data |
|---|---|
| success | 项目json格式数据 |
| error | parameters error |
- 返回值格式
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)]\"}]
号码导入到CRM中
- 说明
方法: PUT
前缀：http://ip:port/uucall_restapi/rest/
路径: file/{uid}/crm/{crmId}
参数校验：无
- 示例
PUT file/{uid}/crm/1123 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 | |
| 输入参数 | 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 |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
| Result | Data |
|---|---|
| success | 成功描述 |
| error | parameters error |
- 返回值格式
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/record
参数校验：无
- 示例
GET cti/record 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 | |
| 输入参数 | page | 第几页 大于1，默认1 | ture | String | |
| 输入参数 | pagesize | 一页几行 大于1，最大不能超过100，默认10 | false | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
| Result | Data |
|---|---|
| success | 成功描述 |
| error | parameters error |
- 返回值格式
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}/record
参数校验：无
- 示例
PUT cti/1225/record 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 | |
| 输入参数 | fileName | 文件名称 | ture | String | |
| 输入参数 | filePath | 文件路径 | true | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
| Result | Data |
|---|---|
| success | 成功描述 |
| error | parameters error |
- 返回值格式
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}/record/{fid}
参数校验：无
- 示例
DELETE cti/1225/record/1111 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 | |
| 输入参数 | fid | 录音包id | ture | Long |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串，具体字段和字段值形式如下：
| Result | Data |
|---|---|
| success | 成功描述 |
| error | parameters error |
- 返回值格式
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)]\"}]
