“子账号及权限”的版本间的差异

来自uucall
跳转至: 导航搜索
(创建页面,内容为“== 查询子帐号以及关联角色信息 == == 新增子帐号以及关联角色信息 == == 获取某子帐号以及其角色信息 == == 修改某帐号以及其...”)
 
第1行: 第1行:
 
== 查询子帐号以及关联角色信息 ==
 
== 查询子帐号以及关联角色信息 ==
 +
* <big>说明</big>
 +
方法: GET<br />
 +
前缀:http://ip:port/uucall_restapi/rest/<br />
 +
路径: /power/roleuser<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
GET /power/roleuser 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 ||
 +
|-
 +
| 输入参数 || name || 姓名 || false || string ||
 +
|-
 +
| 输入参数 || subUserName || 子帐号名称 || false || string ||
 +
|-
 +
| 输入参数 || roleName || 角色名称 || false || string ||
 +
|-
 +
| 输入参数 || jobnumber || 工号 || false || string ||
 +
|-
 +
| 输入参数 || pageSize || 每页多少条记录 || false || string ||
 +
|-
 +
| 输入参数 || page || 第几页 || false || string ||
 +
|-
 +
| 输入参数 || state || 状态( “禁用”或者“启用”) || false || string ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || list<SubUserRole>
 +
|-
 +
| 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 />
 +
路径: /power/roleuser<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
POST /power/roleuser 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 ||
 +
|-
 +
| 输入参数 || name || 姓名 || false || string ||
 +
|-
 +
| 输入参数 || password || 登录密码(长度不超过15个字节) || true || string ||
 +
|-
 +
| 输入参数 || roleId || 角色ID() || false || string ||
 +
|-
 +
| 输入参数 || roleEnble || 是否应用角色权限模版( 1.是 2.否) || false || string ||
 +
|-
 +
| 输入参数 || jobnumber || 工号 || false || string ||
 +
|-
 +
| 输入参数 || account || 帐号名称 || true || string ||
 +
|-
 +
| 输入参数 || body || 子帐号-角色结构体 || true || SubUserRole ||
 +
|}
 +
<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 />
 +
路径: /power/roleuser<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
GET /power/roleuser 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 ||
 +
|-
 +
| 输入参数 || name || 姓名 || false || string ||
 +
|-
 +
| 输入参数 || subUserName || 子帐号名称 || false || string ||
 +
|-
 +
| 输入参数 || roleName || 角色名称 || false || string ||
 +
|-
 +
| 输入参数 || jobnumber || 工号 || false || string ||
 +
|-
 +
| 输入参数 || pageSize || 每页多少条记录 || false || string ||
 +
|-
 +
| 输入参数 || state || 状态( “禁用”或者“启用”) || false || string ||
 +
|-
 +
| 输入参数 || page || 第几页 || false || string ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || list<SubUserRole>
 +
|-
 +
| 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 />
 +
路径: /power/roleuser<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
POST /power/roleuser 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"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || jobnumber || 工号 || false || Long ||
 +
|-
 +
| 输入参数 || roleId || 角色ID() || false || string ||
 +
|-
 +
| 输入参数 || roleEnble || 是否应用角色权限模版( 1.是 2.否) || false || string ||
 +
|-
 +
| 输入参数 || password || 登录密码(长度不超过15个字节) || true || string ||
 +
|-
 +
| 输入参数 || name || 姓名 || true || string ||
 +
|-
 +
| 输入参数 || account || 帐号名称 || true || string ||
 +
|-
 +
| 输入参数 || body || 子帐号-角色结构体 || true || SubUserRole ||
 +
|}
 +
<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 />
 +
路径: /power/subuser<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
GET /power/subuser 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 ||
 +
|-
 +
| 输入参数 || name || 帐号绑定员工姓名 || false || string ||
 +
|-
 +
| 输入参数 || id || 子帐号id() || false || string ||
 +
|-
 +
| 输入参数 || bind_ext || 帐号绑定分机 || false || string ||
 +
|-
 +
| 输入参数 || jobnumber || 工号 || false || string ||
 +
|-
 +
| 输入参数 || account || 子帐号名称 || false || string ||
 +
|-
 +
| 输入参数 || state || 状态( 1有效 2禁用 3已注销 4冻结) || false || string ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || list<SubUser>
 +
|-
 +
| 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 />
 +
路径: /power/subuser/auth/{subUserId}<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
GET /power/subuser/auth/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"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || pid || 上级应用ID || false || string ||
 +
|-
 +
| 输入参数 || subUserId || 帐号ID || true || string ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || list<CustomApplication>
 +
|-
 +
| 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 />
 +
路径: /power/subuser/auth/{subUserId}<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
PUT /power/subuser/auth/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"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || subUserId || 帐号ID || true || Long ||
 +
|-
 +
| 输入参数 || authAppIds || 可访问应用ID( 多值以“,”隔开) || false || string ||
 +
|-
 +
| 输入参数 || unAuthAppIds || 禁止访问应用ID( 多值以“,” 隔开) || 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>
 +
方法: GET<br />
 +
前缀:http://ip:port/uucall_restapi/rest/<br />
 +
路径: /power/subuser/{subUserId}<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
GET /power/subuser/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"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || subUserId || 帐号ID || true || Long ||
 +
|}
 +
<br />
 +
* <big>结构响应</big>
 +
其中相应结果HTTP Code为200的string为json格式字符串,具体字段和字段值形式如下:
 +
{| class="wikitable"
 +
|-
 +
! Result !! Data
 +
|-
 +
| success || list<SubUser>
 +
|-
 +
| 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 />
 +
路径: /power/subuser/{subUserId}<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
PUT /power/subuser/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"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || subUserId || 帐号ID || true || Long ||
 +
|-
 +
| 输入参数 || body || 子帐号结构体 || true || SubUser ||
 +
|}
 +
<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 />
 +
路径: /power/subuser/{subUserId}<br />
 +
参数校验:无
 +
 +
* <big>示例</big>
 +
DELETE /power/subuser/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"
 +
|-
 +
! 类型 !! 参数名 !! 描述 !! 是否必填 !! 数据类型 !! 默认值
 +
|-
 +
| 输入参数 || subUserId || 帐号ID || true || 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 />

2016年4月25日 (一) 17:52的版本

查询子帐号以及关联角色信息

  • 说明
方法: GET
前缀:http://ip:port/uucall_restapi/rest/
路径: /power/roleuser
参数校验:无
  • 示例
GET /power/roleuser 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
输入参数 name 姓名 false string
输入参数 subUserName 子帐号名称 false string
输入参数 roleName 角色名称 false string
输入参数 jobnumber 工号 false string
输入参数 pageSize 每页多少条记录 false string
输入参数 page 第几页 false string
输入参数 state 状态( “禁用”或者“启用”) false string


  • 结构响应

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

Result Data
success list<SubUserRole>
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/
路径: /power/roleuser
参数校验:无
  • 示例
POST /power/roleuser 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
输入参数 name 姓名 false string
输入参数 password 登录密码(长度不超过15个字节) true string
输入参数 roleId 角色ID() false string
输入参数 roleEnble 是否应用角色权限模版( 1.是 2.否) false string
输入参数 jobnumber 工号 false string
输入参数 account 帐号名称 true string
输入参数 body 子帐号-角色结构体 true SubUserRole


  • 结构响应

其中相应结果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/
路径: /power/roleuser
参数校验:无
  • 示例
GET /power/roleuser 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
输入参数 name 姓名 false string
输入参数 subUserName 子帐号名称 false string
输入参数 roleName 角色名称 false string
输入参数 jobnumber 工号 false string
输入参数 pageSize 每页多少条记录 false string
输入参数 state 状态( “禁用”或者“启用”) false string
输入参数 page 第几页 false string


  • 结构响应

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

Result Data
success list<SubUserRole>
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/
路径: /power/roleuser
参数校验:无
  • 示例
POST /power/roleuser 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


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 jobnumber 工号 false Long
输入参数 roleId 角色ID() false string
输入参数 roleEnble 是否应用角色权限模版( 1.是 2.否) false string
输入参数 password 登录密码(长度不超过15个字节) true string
输入参数 name 姓名 true string
输入参数 account 帐号名称 true string
输入参数 body 子帐号-角色结构体 true SubUserRole


  • 结构响应

其中相应结果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/
路径: /power/subuser
参数校验:无
  • 示例
GET /power/subuser 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
输入参数 name 帐号绑定员工姓名 false string
输入参数 id 子帐号id() false string
输入参数 bind_ext 帐号绑定分机 false string
输入参数 jobnumber 工号 false string
输入参数 account 子帐号名称 false string
输入参数 state 状态( 1有效 2禁用 3已注销 4冻结) false string


  • 结构响应

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

Result Data
success list<SubUser>
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/
路径: /power/subuser/auth/{subUserId}
参数校验:无
  • 示例
GET /power/subuser/auth/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


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 pid 上级应用ID false string
输入参数 subUserId 帐号ID true string


  • 结构响应

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

Result Data
success list<CustomApplication>
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/
路径: /power/subuser/auth/{subUserId}
参数校验:无
  • 示例
PUT /power/subuser/auth/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


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 subUserId 帐号ID true Long
输入参数 authAppIds 可访问应用ID( 多值以“,”隔开) false string
输入参数 unAuthAppIds 禁止访问应用ID( 多值以“,” 隔开) 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)]\"}]

获取某子帐号信息

  • 说明
方法: GET
前缀:http://ip:port/uucall_restapi/rest/
路径: /power/subuser/{subUserId}
参数校验:无
  • 示例
GET /power/subuser/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


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 subUserId 帐号ID true Long


  • 结构响应

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

Result Data
success list<SubUser>
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/
路径: /power/subuser/{subUserId}
参数校验:无
  • 示例
PUT /power/subuser/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


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 subUserId 帐号ID true Long
输入参数 body 子帐号结构体 true SubUser


  • 结构响应

其中相应结果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/
路径: /power/subuser/{subUserId}
参数校验:无
  • 示例
DELETE /power/subuser/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


  • 参数列表
类型 参数名 描述 是否必填 数据类型 默认值
输入参数 subUserId 帐号ID true 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)]\"}]