“外呼任务”的版本间的差异
来自uucall
(→修改预测外呼项目) |
|||
第62行: | 第62行: | ||
== 修改预测外呼项目 == | == 修改预测外呼项目 == | ||
+ | === 说明 === | ||
+ | 方法: GET<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/ | ||
+ | 路径: cti/{uid}/project/forcast/{projectId}<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | === 示例 === | ||
+ | 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 | ||
+ | <br /> | ||
+ | |||
+ | === 参数列表 === | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || 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格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data !! Code | ||
+ | |- | ||
+ | | success || [ivr模板json字符串,ivr模板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外呼项目 == |
2016年4月24日 (日) 15:58的版本
目录
创建预测外呼项目
说明
方法: 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)]\"}]