“业务记录”的版本间的差异
(→获取业务记录) |
|||
第244行: | 第244行: | ||
* <big>参数列表</big> | * <big>参数列表</big> | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
第254行: | 第259行: | ||
| 输入参数 || cid || 客户资料编号 || true || Long || | | 输入参数 || cid || 客户资料编号 || true || Long || | ||
|- | |- | ||
− | | 输入参数 || | + | | 输入参数 || startdate || 开始日期 yyyy-MM-dd || false || String || |
+ | |- | ||
+ | | 输入参数 || starttime || 开始时间 HH:mm:ss || false || String || | ||
+ | |- | ||
+ | | 输入参数 || enddate || 结束日期 yyyy-MM-dd || false || String || | ||
+ | |- | ||
+ | | 输入参数 || endtime || 结束时间 HH:mm:ss || false || String || | ||
+ | |- | ||
+ | | 输入参数 || phone || 电话号码 || false || String || | ||
+ | |- | ||
+ | | 输入参数 || createAdmin || 创建人 || false || String || | ||
+ | |- | ||
+ | | 输入参数 || lastEditAdmin || 最后编辑人 || false || String || | ||
+ | |} | ||
|} | |} | ||
<br /> | <br /> |
2016年4月26日 (二) 21:10的版本
获取业务记录字段
- 说明
方法: GET
前缀:http://ip:port/uucall_restapi/rest/
路径: /crm/field/custom
参数校验:无
- 示例
GET /crm/field/custom 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编号 | true | String |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Data |
---|---|
success | list<Field> |
failed | 失败描述 |
- 返回值格式
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/
路径: /crm/field/custom/{fieldid}
参数校验:无
- 示例
PUT /crm/field/custom/1231 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编号 | true | Long | |
输入参数 | fieldid | 字段编号 | true | Long | |
输入参数 | name | 字段名称 | true | string | |
输入参数 | variable | 变量名称 | false | string | |
输入参数 | isChoose | 是否筛选 | false | string | |
输入参数 | isShow | 是否显示 | false | string | |
输入参数 | fieldType | 字段类型 | false | string | |
输入参数 | size | 文本大小 | false | string | |
输入参数 | limit | 文本字段长度限制 | false | string | |
输入参数 | subType | 字段子类型 | false | string | |
输入参数 | values | 字段值 | false | string |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Data |
---|---|
success | 成功描述 |
failed | 失败描述 |
- 返回值格式
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/
路径: /crm/field/custom
参数校验:无
- 示例
POST /crm/field/custom 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编号 | true | Long | |
输入参数 | fieldid | 字段编号 | true | Long | |
输入参数 | name | 字段名称 | true | string | |
输入参数 | variable | 变量名称 | false | string | |
输入参数 | isChoose | 是否筛选 | false | string | |
输入参数 | isShow | 是否显示 | false | string | |
输入参数 | fieldType | 字段类型 | false | txt,radio,chkbox,time | |
输入参数 | size | 文本大小 | false | normal,long,big | |
输入参数 | limit | 文本字段长度限制 | false | 10~99 | |
输入参数 | subType | 字段子类型 | false | 单选:select,a-radio,b-radio 多选:a-chkbox,b-chkbox 时间组件:date,date-range,time-set | |
输入参数 | values | 字段值 | false | string |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Data |
---|---|
success | 成功描述 |
failed | 失败描述 |
- 返回值格式
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/
路径: /crm/field/custom
参数校验:无
- 示例
DELETE /crm/field/custom 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
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | fieldid | 字段编号 | true | int64 | |
输入参数 | uid | 企业帐号ID | true | int64 | |
输入参数 | crmid | CRM编号 | true | int64 |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Data |
---|---|
success | 成功描述 |
failed | 失败描述 |
- 返回值格式
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/
路径: /crm/business/{bid}
参数校验:无
- 示例
GET /crm/business/101 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 |
|
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Data |
---|---|
success | Business |
failed | 失败描述 |
- 返回值格式
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/
路径: /crm/business
参数校验:无
- 示例
POST /crm/business 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编号 | true | Long | |
输入参数 | cid | 客户资料编号 | true | Long | |
输入参数 | phoneid | 通话记录编号 | true | String | |
输入参数 | title | 标题 | false | string | |
输入参数 | property1~property40 | 自定义字段 | false | string |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Data |
---|---|
success | 成功描述 |
failed | 失败描述 |
- 返回值格式
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/
路径: /crm/custom/{cid}
参数校验:无
- 示例
PUT /crm/custom/{bid} 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编号 | true | Long | |
输入参数 | cid | 客户资料编号 | true | Long | |
输入参数 | phoneid | 通话记录编号 | true | String | |
输入参数 | title | 标题 | false | string | |
输入参数 | property1~property40 | 自定义字段 | false | string |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Data |
---|---|
success | 成功描述 |
failed | 失败描述 |
- 返回值格式
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/
路径: /crm/custom/{bid}
参数校验:无
- 示例
DELETE /crm/custom/101 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 | |
输入参数 | bid | 业务记录编号 | true | Long |
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Data |
---|---|
success | 成功描述 |
failed | 失败描述 |
- 返回值格式
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)]\"}]