“客户资料”的版本间的差异

来自uucall
跳转至: 导航搜索
(创建页面,内容为“== 获取客户资料字段 == == 修改客户资料字段 == == 新增客户资料字段 == == 删除客户资料字段 == == 获取客户资料 == == 新增客户...”)
 
第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 />
 +
{\"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/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 />
 +
<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 />
 +
{\"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>
 +
方法: 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 />
 +
<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 />
 +
{\"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>
 +
方法: 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 />
 +
{\"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>
 +
方法: GET<br />
 +
前缀:http://ip:port/uucall_restapi/rest/<br />
 +
路径: /crm/custom/{cid}<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
GET /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 ||
 +
|-
 +
| 输入参数 || crmid || CRM编号 || true || Long ||
 +
|-
 +
| 输入参数 || cid || 客户资料编号 || true || Long ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || Custom
 +
|-
 +
| 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>
 +
方法: POST<br />
 +
前缀:http://ip:port/uucall_restapi/rest/<br />
 +
路径: /crm/custom<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
POST /crm/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 || Long ||
 +
|-
 +
| 输入参数 || phone || 电话号码 || true || Long ||
 +
|-
 +
| 输入参数 || seat || 座席号码 || 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 />
 +
 
== 修改客户资料 ==
 
== 修改客户资料 ==
 +
== CRM列表查询 ==
 +
* <big>说明</big>
 +
方法: PUT<br />
 +
前缀:http://ip:port/uucall_restapi/rest/<br />
 +
路径: /crm/custom/{cid}<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
PUT /crm/custom/{cid} 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 ||
 +
|-
 +
| 输入参数 || phone || 电话号码 || true || Long ||
 +
|-
 +
| 输入参数 || seat || 座席号码 || false || string ||
 +
|-
 +
| 输入参数 || property1~property40 || 自定义字段 || false || string ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || list<crm>
 +
|-
 +
| 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>
 +
方法: DELETE<br />
 +
前缀:http://ip:port/uucall_restapi/rest/<br />
 +
路径: /crm/custom/{cid}<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 ||
 +
|-
 +
| 输入参数 || cid || 客户资料编号 || 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 />
 +
{\"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日 (一) 22:11的版本

获取客户资料字段

  • 说明
方法: 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/custom/{cid}
参数校验:无
  • 示例
GET /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
输入参数 crmid CRM编号 true Long
输入参数 cid 客户资料编号 true Long


  • 结构响应

其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:

Result Data
success Custom
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/custom
参数校验:无
  • 示例
POST /crm/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
输入参数 phone 电话号码 true Long
输入参数 seat 座席号码 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/{cid} 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
输入参数 phone 电话号码 true Long
输入参数 seat 座席号码 false string
输入参数 property1~property40 自定义字段 false string


  • 结构响应

其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:

Result Data
success list<crm>
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/{cid}
参数校验:无
  • 示例
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
输入参数 cid 客户资料编号 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)]\"}]