“文件管理”的版本间的差异
第1行: | 第1行: | ||
== 文件管理 == | == 文件管理 == | ||
=== 文件管理查询 === | === 文件管理查询 === | ||
+ | === 说明 === | ||
+ | 方法: GET<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/ | ||
+ | 路径: file/data<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 | ||
+ | <br /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || page || 第几页 大于0,默认1 || false || int || | ||
+ | |- | ||
+ | | 输入参数 || pagesize || 一页几行大于0,最大不能超过100,默认10 || false || Int || | ||
+ | |} | ||
+ | |||
+ | === 结构响应 === | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data !! Code | ||
+ | |- | ||
+ | | success || list<data> || 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/ | ||
+ | 路径: file/data<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 | ||
+ | <br /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || fileName || 文件名称 || ture || String || | ||
+ | |- | ||
+ | | 输入参数 || myFile || 上传文件 || false || File || | ||
+ | |} | ||
+ | |||
+ | === 结构响应 === | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | error || parameters error | ||
+ | |} | ||
+ | |||
+ | === 返回值格式 === | ||
+ | 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/ | ||
+ | 路径: file/{uid}/data<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 | ||
+ | <br /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || fileName || 文件名称 || ture || String || | ||
+ | |- | ||
+ | | 输入参数 || filePath || 文件路径 || ture || String || | ||
+ | |} | ||
+ | |||
+ | === 结构响应 === | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 项目json格式数据 | ||
+ | |- | ||
+ | | error || parameters error | ||
+ | |} | ||
+ | |||
+ | === 返回值格式 === | ||
+ | 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/ | ||
+ | 路径: file/{uid}/data<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 | ||
+ | <br /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || fid || 文件id || ture || String || | ||
+ | |} | ||
+ | |||
+ | === 结构响应 === | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 项目json格式数据 | ||
+ | |- | ||
+ | | error || parameters error | ||
+ | |} | ||
+ | |||
+ | === 返回值格式 === | ||
+ | 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/ | ||
+ | 路径: file/{uid}/project/{projectId}<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| 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 || | ||
+ | |} | ||
+ | |||
+ | === 结构响应 === | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 项目json格式数据 | ||
+ | |- | ||
+ | | error || parameters error | ||
+ | |} | ||
+ | |||
+ | === 返回值格式 === | ||
+ | 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 /> | ||
+ | |||
=== 号码导入到CRM中 === | === 号码导入到CRM中 === | ||
+ | === 说明 === | ||
+ | 方法: PUT<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/ | ||
+ | 路径: file/{uid}/crm/{crmId}<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 | ||
+ | <br /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| 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 || | ||
+ | |} | ||
+ | |||
+ | === 结构响应 === | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | error || parameters error | ||
+ | |} | ||
+ | |||
+ | === 返回值格式 === | ||
+ | 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/record<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 | ||
+ | <br /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || page || 第几页 大于1,默认1 || ture || String || | ||
+ | |- | ||
+ | | 输入参数 || pagesize || 一页几行 大于1,最大不能超过100,默认10 || false || String || | ||
+ | |} | ||
+ | |||
+ | === 结构响应 === | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | error || parameters error | ||
+ | |} | ||
+ | |||
+ | === 返回值格式 === | ||
+ | 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}/record<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 | ||
+ | <br /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || fileName || 文件名称 || ture || String || | ||
+ | |- | ||
+ | | 输入参数 || filePath || 文件路径 || true || String || | ||
+ | |} | ||
+ | |||
+ | === 结构响应 === | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | error || parameters error | ||
+ | |} | ||
+ | |||
+ | === 返回值格式 === | ||
+ | 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}/record/{fid}<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 | ||
+ | <br /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || fid || 录音包id || ture || Long || | ||
+ | |} | ||
+ | |||
+ | === 结构响应 === | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | error || parameters error | ||
+ | |} | ||
+ | |||
+ | === 返回值格式 === | ||
+ | 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月25日 (一) 15:37的版本
目录
- 1 文件管理
- 1.1 文件管理查询
- 1.2 说明
- 1.3 示例
- 1.4 参数列表
- 1.5 结构响应
- 1.6 返回值格式
- 1.7 文件上传
- 1.8 说明
- 1.9 示例
- 1.10 参数列表
- 1.11 结构响应
- 1.12 返回值格式
- 1.13 文件下载
- 1.14 说明
- 1.15 示例
- 1.16 参数列表
- 1.17 结构响应
- 1.18 返回值格式
- 1.19 文件删除
- 1.20 说明
- 1.21 示例
- 1.22 参数列表
- 1.23 结构响应
- 1.24 返回值格式
- 1.25 号码导入到项目的批次中
- 1.26 说明
- 1.27 示例
- 1.28 参数列表
- 1.29 结构响应
- 1.30 返回值格式
- 1.31 号码导入到CRM中
- 1.32 说明
- 1.33 示例
- 1.34 参数列表
- 1.35 结构响应
- 1.36 返回值格式
- 2 录音包管理
文件管理
文件管理查询
说明
方法: 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)]\"}]