“业务记录”的版本间的差异
(创建页面,内容为“== 获取业务记录字段 == == 新增业务记录字段 == == 修改业务记录字段 == == 删除业务记录字段 == == 获取业务记录 == == 新增业务...”) |
(→修改业务记录) |
||
(未显示同一用户的15个中间版本) | |||
第1行: | 第1行: | ||
== 获取业务记录字段 == | == 获取业务记录字段 == | ||
− | == | + | * <big>说明</big> |
+ | 方法: GET<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
+ | 路径: /crm/field/custom<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | * <big>示例</big> | ||
+ | GET /crm/field/custom 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编号 || true || String || | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>结构响应</big> | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || list<Field> | ||
+ | |- | ||
+ | | failed || 失败描述 | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>返回值格式</big> | ||
+ | application/json<br /> | ||
+ | 其中 ivr模板json字符串 形式如下:<br /> | ||
+ | <br /> | ||
+ | {"result":"SUCCESS","data":[{"crmid":20042,"fieldType":1,"fieldValListSize":0,"id":951,"isChoose":1,"isEdit":1,"isShow":1,"lastEditTime":1450688842,"lengthlimit":255,"name":"标题","setCrmid":true,"setFieldType":true,"setFieldValList":false,"setFieldValues":false,"setId":true,"setIsChoose":true,"setIsEdit":true,"setIsShow":true,"setLastEditTime":true,"setLengthlimit":true,"setName":true,"setShowType":true,"setSize":true,"setSubType":true,"setTableField":true,"setType":true,"setUid":true,"setVariable":true,"showType":1,"size":0,"subType":0,"tableField":"title","type":2,"uid":1225,"variable":"title"}],"code":100,"msg":"success"} | ||
+ | <br /> | ||
+ | |||
== 修改业务记录字段 == | == 修改业务记录字段 == | ||
+ | * <big>说明</big> | ||
+ | 方法: PUT<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
+ | 路径: /crm/field/custom/{fieldid}<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | * <big>示例</big> | ||
+ | PUT /crm/field/custom/1231 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 /> | ||
+ | { | ||
+ | "name":"2备注",<br /> | ||
+ | "variable":"g44422g",<br /> | ||
+ | "isShow":"true",<br /> | ||
+ | "isChoose":"true",<br /> | ||
+ | "fieldType":"txt",<br /> | ||
+ | "size":"normal",<br /> | ||
+ | "limit":"25",<br /> | ||
+ | "values":"备注备注"<br /> | ||
+ | } | ||
+ | <br /> | ||
+ | |||
+ | * <big>参数列表</big> | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || 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 || | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>结构响应</big> | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | failed || 失败描述 | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>返回值格式</big> | ||
+ | application/json<br /> | ||
+ | 其中 ivr模板json字符串 形式如下:<br /> | ||
+ | <br /> | ||
+ | {"result":"SUCCESS","code":100,"msg":"success"} | ||
+ | <br /> | ||
+ | |||
+ | == 新增业务记录字段 == | ||
+ | * <big>说明</big> | ||
+ | 方法: POST<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
+ | 路径: /crm/field/custom<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | * <big>示例</big> | ||
+ | POST /crm/field/custom 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 /> | ||
+ | { | ||
+ | "name":"2备注",<br /> | ||
+ | "variable":"g44422g",<br /> | ||
+ | "isShow":"true",<br /> | ||
+ | "isChoose":"true",<br /> | ||
+ | "fieldType":"txt",<br /> | ||
+ | "size":"normal",<br /> | ||
+ | "limit":"25",<br /> | ||
+ | "values":"备注备注"<br /> | ||
+ | } | ||
+ | <br /> | ||
+ | |||
+ | * <big>参数列表</big> | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || 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 || | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>结构响应</big> | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | failed || 失败描述 | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>返回值格式</big> | ||
+ | application/json<br /> | ||
+ | 其中 ivr模板json字符串 形式如下:<br /> | ||
+ | <br /> | ||
+ | {"result":"SUCCESS","code":100,"msg":"success"} | ||
+ | <br /> | ||
+ | |||
== 删除业务记录字段 == | == 删除业务记录字段 == | ||
+ | * <big>说明</big> | ||
+ | 方法: DELETE<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
+ | 路径: /crm/field/custom<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | * <big>示例</big> | ||
+ | DELETE /crm/field/custom 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" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || fieldid || 字段编号 || true || int64 || | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || int64 || | ||
+ | |- | ||
+ | | 输入参数 || crmid || CRM编号 || true || int64 || | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>结构响应</big> | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | failed || 失败描述 | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>返回值格式</big> | ||
+ | application/json<br /> | ||
+ | 其中 ivr模板json字符串 形式如下:<br /> | ||
+ | <br /> | ||
+ | {"result":"SUCCESS","code":100,"msg":"success"} | ||
+ | <br /> | ||
+ | |||
== 获取业务记录 == | == 获取业务记录 == | ||
+ | * <big>说明</big> | ||
+ | 方法: GET<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
+ | 路径: /crm/business/{bid}<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | * <big>示例</big> | ||
+ | GET /crm/business/101 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编号 || 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 /> | ||
+ | * <big>结构响应</big> | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || Business | ||
+ | |- | ||
+ | | failed || 失败描述 | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>返回值格式</big> | ||
+ | application/json<br /> | ||
+ | 其中 ivr模板json字符串 形式如下:<br /> | ||
+ | <br /> | ||
+ | {"result":"SUCCESS","data":[],"code":100,"msg":"success"} | ||
+ | <br /> | ||
+ | |||
== 新增业务记录 == | == 新增业务记录 == | ||
+ | * <big>说明</big> | ||
+ | 方法: POST<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
+ | 路径: /crm/business<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | * <big>示例</big> | ||
+ | POST /crm/business 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 /> | ||
+ | { | ||
+ | "phoneid":"gfdshgfhadgshjdsgds",<br /> | ||
+ | "title":"2016年",<br /> | ||
+ | "property1":"沪深嫁汉嫁汉笔记本一哈"<br /> | ||
+ | } | ||
+ | <br /> | ||
+ | |||
+ | * <big>参数列表</big> | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || crmid || CRM编号 || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || cid || 客户资料编号 || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || phoneid || 通话记录编号 || true || String || | ||
+ | |- | ||
+ | | 输入参数 || title || 标题 || false || string || | ||
+ | |- | ||
+ | | 输入参数 || property1~property40 || 自定义字段 || false || string || | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>结构响应</big> | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | failed || 失败描述 | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>返回值格式</big> | ||
+ | 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 /> | ||
+ | |||
== 修改业务记录 == | == 修改业务记录 == | ||
+ | * <big>说明</big> | ||
+ | 方法: PUT<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
+ | 路径: /crm/custom/{cid}<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | * <big>示例</big> | ||
+ | PUT /crm/custom/{bid} 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 /> | ||
+ | { | ||
+ | "phoneid":"gfdshgfhadgshjdsgds",<br /> | ||
+ | "title":"2016年",<br /> | ||
+ | "property1":"沪深嫁汉嫁汉笔记本一哈"<br /> | ||
+ | } | ||
+ | <br /> | ||
+ | |||
+ | * <big>参数列表</big> | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值 | ||
+ | |- | ||
+ | | 输入参数 || uid || 企业帐号ID || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || crmid || CRM编号 || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || cid || 客户资料编号 || true || Long || | ||
+ | |- | ||
+ | | 输入参数 || phoneid || 通话记录编号 || true || String || | ||
+ | |- | ||
+ | | 输入参数 || title || 标题 || false || string || | ||
+ | |- | ||
+ | | 输入参数 || property1~property40 || 自定义字段 || false || string || | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>结构响应</big> | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | failed || 失败描述 | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>返回值格式</big> | ||
+ | application/json<br /> | ||
+ | 其中 ivr模板json字符串 形式如下:<br /> | ||
+ | <br /> | ||
+ | {"result":"SUCCESS","code":100,"msg":"success"} | ||
+ | <br /> | ||
+ | |||
== 删除业务记录 == | == 删除业务记录 == | ||
+ | * <big>说明</big> | ||
+ | 方法: DELETE<br /> | ||
+ | 前缀:http://ip:port/uucall_restapi/rest/<br /> | ||
+ | 路径: /crm/custom/{bid}<br /> | ||
+ | 参数校验:无 | ||
+ | |||
+ | * <big>示例</big> | ||
+ | DELETE /crm/custom/101 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 || | ||
+ | |- | ||
+ | | 输入参数 || bid || 业务记录编号 || true || Long || | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>结构响应</big> | ||
+ | 其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下: | ||
+ | {| class="wikitable" | ||
+ | |- | ||
+ | ! Result !! Data | ||
+ | |- | ||
+ | | success || 成功描述 | ||
+ | |- | ||
+ | | failed || 失败描述 | ||
+ | |} | ||
+ | <br /> | ||
+ | * <big>返回值格式</big> | ||
+ | application/json<br /> | ||
+ | 其中 ivr模板json字符串 形式如下:<br /> | ||
+ | <br /> | ||
+ | {"result":"SUCCESS","code":100,"msg":"success"} | ||
+ | <br /> |
2016年4月26日 (二) 21:30的最新版本
获取业务记录字段
- 说明
方法: 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字符串 形式如下:
{"result":"SUCCESS","data":[{"crmid":20042,"fieldType":1,"fieldValListSize":0,"id":951,"isChoose":1,"isEdit":1,"isShow":1,"lastEditTime":1450688842,"lengthlimit":255,"name":"标题","setCrmid":true,"setFieldType":true,"setFieldValList":false,"setFieldValues":false,"setId":true,"setIsChoose":true,"setIsEdit":true,"setIsShow":true,"setLastEditTime":true,"setLengthlimit":true,"setName":true,"setShowType":true,"setSize":true,"setSubType":true,"setTableField":true,"setType":true,"setUid":true,"setVariable":true,"showType":1,"size":0,"subType":0,"tableField":"title","type":2,"uid":1225,"variable":"title"}],"code":100,"msg":"success"}
修改业务记录字段
- 说明
方法: 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
{ "name":"2备注",
"variable":"g44422g",
"isShow":"true",
"isChoose":"true",
"fieldType":"txt",
"size":"normal",
"limit":"25",
"values":"备注备注"
}
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | 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字符串 形式如下:
{"result":"SUCCESS","code":100,"msg":"success"}
新增业务记录字段
- 说明
方法: 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
{ "name":"2备注",
"variable":"g44422g",
"isShow":"true",
"isChoose":"true",
"fieldType":"txt",
"size":"normal",
"limit":"25",
"values":"备注备注"
}
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | 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字符串 形式如下:
{"result":"SUCCESS","code":100,"msg":"success"}
删除业务记录字段
- 说明
方法: 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字符串 形式如下:
{"result":"SUCCESS","code":100,"msg":"success"}
获取业务记录
- 说明
方法: 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 | |
输入参数 | crmid | CRM编号 | 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 |
|}
- 结构响应
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
Result | Data |
---|---|
success | Business |
failed | 失败描述 |
- 返回值格式
application/json
其中 ivr模板json字符串 形式如下:
{"result":"SUCCESS","data":[],"code":100,"msg":"success"}
新增业务记录
- 说明
方法: 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
{ "phoneid":"gfdshgfhadgshjdsgds",
"title":"2016年",
"property1":"沪深嫁汉嫁汉笔记本一哈"
}
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | 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)]\"}]
修改业务记录
- 说明
方法: 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
{ "phoneid":"gfdshgfhadgshjdsgds",
"title":"2016年",
"property1":"沪深嫁汉嫁汉笔记本一哈"
}
- 参数列表
类型 | 参数名 | 描述 | 是否必填 | 数据类型 | 默认值 |
---|---|---|---|---|---|
输入参数 | 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字符串 形式如下:
{"result":"SUCCESS","code":100,"msg":"success"}
删除业务记录
- 说明
方法: 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字符串 形式如下:
{"result":"SUCCESS","code":100,"msg":"success"}