外呼任务

来自uucall
Admin讨论 | 贡献2016年3月23日 (三) 15:12的版本

跳转至: 导航搜索


目录

UUC REST API


1. 预览

1.1. 版本信息

Version: 1.0.0

1.2. 联系方式

Contact: <a href="mailto:452009426@qq.com">452009426@qq.com</a> Contact Email: <a href="mailto:452009426@qq.com">452009426@qq.com</a>

1.3. URI 格式

Host: cloud.uucall.cn:80 BasePath: /rest Schemes: HTTP

1.4. 标签

·         power

·         account

2. 路径

2.1. 获取充值记录

<span lang=EN style='mso-ansi-language:EN'>GET /account/cashlog</span>

2.1.1. 描述

获取充值记录

2.1.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

pageSize

每页多少条记录

false

string

查询参数

uid

企业帐号ID

ture

string

查询参数

page

第几页

false

string

2.1.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_cashlog">CashLog</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.1.4. 返回值格式

·         application/json

2.1.5. 标签

·         account

2.2. 获取扣费账单

<span lang=EN style='mso-ansi-language:EN'>GET /account/chargebill</span>

2.2.1. 描述

获取扣费账单

2.2.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

account

帐号

false

string

查询参数

page

第几页

false

string

查询参数

pageSize

每页多少条记录

false

string

查询参数

time

统计时间( 格式为“yyyy-MM”

false

string

查询参数

uidName

企业帐号

true

string

2.2.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_chargebill">ChargeBill</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.2.4. 返回值格式

·         application/json

2.2.5. 标签

·         account

2.3. 获取基础消费账单

<span lang=EN style='mso-ansi-language:EN'>GET /account/chargebill/basicbill</span>

2.3.1. 描述

获取基础消费账单

2.3.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

subUserName

帐号名称

true

string

查询参数

time

统计时间( 格式为“yyyy-MM”

false

string

查询参数

page

第几页()

false

string

查询参数

pageSize

每页现实多少条记录()

false

string

查询参数

uidName

企业名称

true

string

2.3.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_basicbill">BasicBill</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.3.4. 返回值格式

·         application/json

2.3.5. 标签

·         account

2.4. 获取功能消费账单

<span lang=EN style='mso-ansi-language:EN'>GET /account/chargebill/funbill</span>

2.4.1. 描述

获取功能消费账单

2.4.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

pageSize

每页多少条记录

false

string

查询参数

uidName

企业名称

true

string

查询参数

subUserName

帐号名称

true

string

查询参数

time

统计时间( 格式为“yyyy-MM”

false

string

查询参数

page

第几页

false

string

2.4.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_funbill">FunBill</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.4.4. 返回值格式

·         application/json

2.4.5. 标签

·         account

2.5. 下载扣费账单

<span lang=EN style='mso-ansi-language:EN'>GET /account/file/chargebill</span>

2.5.1. 描述

下载扣费账单

2.5.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

time

统计时间( 格式为“yyyy-MM”

false

string

查询参数

uidName

企业名称

true

string

查询参数

account

帐号

false

string

2.5.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.5.4. 标签

·         account

2.6. 下载基础扣费账单

<span lang=EN style='mso-ansi-language:EN'>GET /account/file/chargebill/basicbill</span>

2.6.1. 描述

下载基础扣费账单

2.6.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

subUserName

帐号名称

true

string

查询参数

time

统计时间( 格式为“yyyy-MM”

false

string

查询参数

uidName

企业名称

true

string

2.6.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.6.4. 标签

·         account

2.7. 下载功能消费账单

<span lang=EN style='mso-ansi-language:EN'>GET /account/file/chargebill/funbill</span>

2.7.1. 描述

下载功能消费账单

2.7.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

subUserName

账户名称

true

string

查询参数

uidName

企业名称

true

string

查询参数

time

统计时间( 格式“yyyy-MM”

false

string

2.7.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_funbill">FunBill</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.7.4. 返回值格式

·         application/json

2.7.5. 标签

·         account

2.8. 获取企业计费账户信息

<span lang=EN style='mso-ansi-language:EN'>GET /account/{uid}</span>

2.8.1. 描述

获取企业计费账户信息

2.8.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

uid

企业ID

true

string

2.8.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_billingaccount">BillingAccount</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.8.4. 返回值格式

·         application/json

2.8.5. 标签

·         account

2.9. 获取基本汇率标准

<span lang=EN style='mso-ansi-language:EN'>GET /account/{uid}/baserate</span>

2.9.1. 描述

获取基本汇率标准

2.9.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

uid

企业ID

true

string

2.9.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_rulerate">RuleRate</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.9.4. 返回值格式

·         application/json

2.9.5. 标签

·         account

2.10. 获取功能资费标准

<span lang=EN style='mso-ansi-language:EN'>GET /account/{uid}/funrate</span>

2.10.1. 描述

获取功能资费标准

2.10.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

uid

企业ID

true

string

2.10.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_funrate">FunRate</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.10.4. 返回值格式

·         application/json

2.10.5. 标签

·         account

2.11. 获取时长卡信息

<span lang=EN style='mso-ansi-language:EN'>GET /account/{uid}/giftrate</span>

2.11.1. 描述

获取时长卡信息

2.11.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

uid

企业ID

true

string

查询参数

page

第几页()

false

string

查询参数

pageSize

每页几条记录

false

string

2.11.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_giftrate">GiftRate</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.11.4. 返回值格式

·         application/json

2.11.5. 标签

·         account

2.12. 获取话务租用信息

<span lang=EN style='mso-ansi-language:EN'>GET /account/{uid}/hirerate</span>

2.12.1. 描述

获取话务租用信息

2.12.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

uid

企业ID

true

string

2.12.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_hirerate">HireRate</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.12.4. 返回值格式

·         application/json

2.12.5. 标签

·         account

2.13. 获取公告

<span lang=EN style='mso-ansi-language:EN'>GET /power/notice</span>

2.13.1. 描述

获取公告

2.13.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

id

公告ID()

false

string

查询参数

title

标题

false

string

查询参数

uid

企业ID

true

string

2.13.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_notice">Notice</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.13.4. 返回值格式

·         application/json

2.13.5. 标签

·         power

2.14. 新增公告

<span lang=EN style='mso-ansi-language:EN'>POST /power/notice</span>

2.14.1. 描述

新增公告

2.14.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

输入参数

body

公告结构体

true

<a href="#_notice">Notice</a>

2.14.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

201

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.14.4. Consumes

·         application/json

2.14.5. 标签

·         power

2.15. 获取某公告信息

<span lang=EN style='mso-ansi-language:EN'>GET /power/notice/{noticeId}</span>

2.15.1. 描述

获取某公告信息

2.15.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

noticeId

公告ID

true

string

查询参数

uid

企业ID

true

string

2.15.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_notice">Notice</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.15.4. 返回值格式

·         application/json

2.15.5. 标签

·         power

2.16. 修改某公告信息

<span lang=EN style='mso-ansi-language:EN'>PUT /power/notice/{noticeId}</span>

2.16.1. 描述

修改某公告信息

2.16.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

noticeId

公告ID

true

string

查询参数

uid

企业ID

true

string

输入参数

body

公告结构体

true

<a href="#_notice">Notice</a>

2.16.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.16.4. Consumes

·         application/json

2.16.5. 标签

·         power

2.17. 删除某公告信息

<span lang=EN style='mso-ansi-language:EN'>DELETE /power/notice/{noticeId}</span>

2.17.1. 描述

删除某公告信息

2.17.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

uid

企业ID

true

string

路径参数

noticeId

公告ID

true

string

2.17.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.17.4. 标签

·         power

2.18. 获取操作日志

<span lang=EN style='mso-ansi-language:EN'>GET /power/oplog</span>

2.18.1. 描述

获取操作日志

2.18.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

subUserName

帐号名称()

false

string

查询参数

endTime

操作终止时间( 格式为“yyyy-MM-dd HH:mm:ss”

false

string

查询参数

id

操作日志ID()

false

string

查询参数

startTime

操作起始时间( 格式为“yyyy-MM-dd HH:mm:ss”

false

string

查询参数

uid

企业ID

true

string

2.18.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_oplogsubuser">OpLogSubUser</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.18.4. 返回值格式

·         application/json

2.18.5. 标签

·         power

2.19. 获取角色信息

<span lang=EN style='mso-ansi-language:EN'>GET /power/role</span>

2.19.1. 描述

获取角色信息

2.19.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

uid

企业ID

true

string

查询参数

name

角色名称

false

string

2.19.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_role">Role</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.19.4. 返回值格式

·         application/json

2.19.5. 标签

·         power

2.20. 新增角色信息

<span lang=EN style='mso-ansi-language:EN'>POST /power/role</span>

2.20.1. 描述

新增角色信息

2.20.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

uid

企业ID

true

string

查询参数

name

角色名称

true

string

输入参数

body

角色结构体

true

<a href="#_role">Role</a>

2.20.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

201

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.20.4. Consumes

·         application/json

2.20.5. 标签

·         power

2.21. 获取当前角色可访问应用信息

<span lang=EN style='mso-ansi-language:EN'>GET /power/role/auth/{roleId}</span>

2.21.1. 描述

获取当前角色可访问应用信息

2.21.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

roleId

角色ID

true

string

查询参数

uid

企业ID

true

string

2.21.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_customapplication">CustomApplication</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.21.4. 返回值格式

·         application/json

2.21.5. 标签

·         power

2.22. 修改当前角色可访问应用权限

<span lang=EN style='mso-ansi-language:EN'>PUT /power/role/auth/{roleId}</span>

2.22.1. 描述

修改当前角色可访问应用权限

2.22.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

roleId

角色ID

true

string

查询参数

authAppIds

可访问应用ID( 多值以“,”隔开)

false

string

查询参数

unAuthAppIds

不可访问应用ID( 多值以","隔开)

false

string

2.22.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.22.4. 标签

·         power

2.23. 修改某角色信息

<span lang=EN style='mso-ansi-language:EN'>PUT /power/role/{roleId}</span>

2.23.1. 描述

修改某角色信息

2.23.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

roleId

角色ID

true

string

输入参数

body

角色结构体

true

<a href="#_role">Role</a>

2.23.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.23.4. Consumes

·         application/json

2.23.5. 标签

·         power

2.24. 删除某角色信息

<span lang=EN style='mso-ansi-language:EN'>DELETE /power/role/{roleId}</span>

2.24.1. 描述

删除某角色信息

2.24.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

roleId

角色ID

true

string

2.24.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.24.4. 标签

·         power

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

<span lang=EN style='mso-ansi-language:EN'>GET /power/roleuser</span>

2.25.1. 描述

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

2.25.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

name

姓名

false

string

查询参数

subUserName

子帐号名称

false

string

查询参数

roleName

角色名称

false

string

查询参数

jobnumber

工号

false

string

查询参数

pageSize

每页多少条记录

false

string

查询参数

state

状态(禁用或者启用

false

string

查询参数

uid

企业帐号ID

true

string

查询参数

page

第几页

false

string

2.25.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_subuserrole">SubUserRole</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.25.4. 返回值格式

·         application/json

2.25.5. 标签

·         power

2.26. 新增子帐号以及关联角色信息

<span lang=EN style='mso-ansi-language:EN'>POST /power/roleuser</span>

2.26.1. 描述

新增子帐号以及关联角色信息

2.26.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

jobnumber

工号

false

string

查询参数

roleId

角色ID()

false

string

查询参数

roleEnble

是否应用角色权限模版( 1. 2.否)

false

string

查询参数

password

登录密码(长度不超过15个字节)

true

string

查询参数

name

姓名

true

string

查询参数

account

帐号名称

true

string

输入参数

body

子帐号-角色结构体

true

<a href="#_subuserrole">SubUserRole</a>

2.26.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

201

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.26.4. Consumes

·         application/json

2.26.5. 标签

·         power

2.27. 获取某子帐号以及其角色信息

<span lang=EN style='mso-ansi-language:EN'>GET /power/roleuser/{subUserId}</span>

2.27.1. 描述

获取某子帐号以及其角色信息

2.27.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

subUserId

子帐号ID

true

string

2.27.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_subuserrole">SubUserRole</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.27.4. 返回值格式

·         application/json

2.27.5. 标签

·         power

2.28. 修改某帐号以及其角色信息

<span lang=EN style='mso-ansi-language:EN'>PUT /power/roleuser/{subUserId}</span>

2.28.1. 描述

修改某帐号以及其角色信息

2.28.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

subUserId

子帐号ID

true

string

输入参数

body

子帐号-角色结构体

true

<a href="#_subuserrole">SubUserRole</a>

2.28.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.28.4. Consumes

·         application/json

2.28.5. 标签

·         power

2.29. 查询子帐号信息

<span lang=EN style='mso-ansi-language:EN'>GET /power/subuser</span>

2.29.1. 描述

查询子帐号信息

2.29.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

name

帐号绑定员工姓名

false

string

查询参数

id

子帐号id()

false

string

查询参数

bind_ext

帐号绑定分机

false

string

查询参数

jobnumber

工号

false

string

查询参数

account

子帐号名称

false

string

查询参数

uid

企业帐号ID

true

string

查询参数

state

状态( 1有效 2禁用 3已注销 4冻结)

false

string

2.29.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_subuser">SubUser</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.29.4. 返回值格式

·         application/json

2.29.5. 标签

·         power

2.30. 获取当前帐号可访问应用信息

<span lang=EN style='mso-ansi-language:EN'>GET /power/subuser/auth/{subUserId}</span>

2.30.1. 描述

获取当前帐号可访问应用信息

2.30.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

查询参数

pid

上级应用ID

false

string

路径参数

subUserId

帐号ID

true

string

2.30.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_customapplication">CustomApplication</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.30.4. 返回值格式

·         application/json

2.30.5. 标签

·         power

2.31. 修改当前帐号应用可访问权限

<span lang=EN style='mso-ansi-language:EN'>PUT /power/subuser/auth/{subUserId}</span>

2.31.1. 描述

修改当前帐号应用可访问权限

2.31.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

subUserId

帐号ID

true

string

查询参数

authAppIds

可访问应用ID 多值以“,”隔开)

false

string

查询参数

unAuthAppIds

禁止访问应用ID( 多值以“,” 隔开)

false

string

2.31.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.31.4. 标签

·         power

2.32. 获取某子帐号信息

<span lang=EN style='mso-ansi-language:EN'>GET /power/subuser/{subUserId}</span>

2.32.1. 描述

获取某子帐号信息

2.32.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

subUserId

帐号ID

true

string

2.32.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

<a href="#_subuser">SubUser</a>

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.32.4. 返回值格式

·         application/json

2.32.5. 标签

·         power

2.33. 修改某子帐号信息

<span lang=EN style='mso-ansi-language:EN'>PUT /power/subuser/{subUserId}</span>

2.33.1. 描述

修改某子帐号信息

2.33.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

subUserId

帐号ID

true

string

输入参数

body

子帐号结构体

true

<a href="#_subuser">SubUser</a>

2.33.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.33.4. Consumes

·         application/json

2.33.5. 标签

·         power

2.34. 删除某子帐号信息

<span lang=EN style='mso-ansi-language:EN'>DELETE /power/subuser/{subUserId}</span>

2.34.1. 描述

删除某子帐号信息

2.34.2. 参数列表

<colgroup><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"><col style="width: 16%;"></colgroup> <thead> </thead>

类型

参数名

描述

是否必填

数据类型

默认值

路径参数

subUserId

帐号ID

true

string

2.34.3. 响应

<colgroup><col style="width: 33%;"><col style="width: 33%;"><col style="width: 33%;"></colgroup> <thead> </thead>

HTTP Code

描述

数据类型

429

Error 429

No Content

405

Error 405

No Content

200

Success

No Content

401

Error 401

No Content

403

Error 403

No Content

500

Error 500

No Content

424

Error 424

No Content

2.34.4. 标签

·         power

3. Definitions

3.1. FunRate

功能资费

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

name

true

string

nextRateTime

true

integer (int64)

chargeUnit

true

string

3.2. BaseUser

企业帐号

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

uid

true

integer (int64)

createTime

false

integer (int64)

contacts_addr

false

string

contacts_email

false

string

state

true

integer (int64)

expDate

false

integer (int64)

type

true

integer (int64)

password

true

string

contacts

false

string

contacts_phone

false

string

name

true

string

permissions_code

false

integer (int64)

note

false

string

billing_account

false

integer (int64)

business_ownership

false

string

3.3. SubUser

子帐号

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

uid

true

integer (int64)

state

true

integer (int64)

login_ip

false

integer (int64)

password

true

string

history_online_count

false

integer (int64)

id

true

integer (int64)

createtime

true

integer (int64)

jobnumber

false

string

history_online_time

false

integer (int64)

login_time

false

integer (int64)

login_server

false

string

email

false

string

name

false

string

account

true

string

mphone

false

string

dept

false

string

login_version

false

integer (int64)

bind_ext

false

integer (int64)

note

false

string

login_os_info

false

string

3.4. BillingAccount

计费账户

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

balance

true

integer (int64)

overdraft

true

integer (int64)

name

true

string

state

true

integer (int64)

account

true

integer (int64)

note

true

string

advance

true

integer (int64)

consume

true

integer (int64)

3.5. CashLog

充值记录

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

id

true

integer (int64)

account_time

true

integer (int64)

money

true

integer (int64)

type

true

integer (int64)

note

false

string

serial_number

false

string

3.6. GiftRate

时长卡

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

id

true

integer (int64)

expirationTime

true

integer (int64)

giftTime

true

integer (int64)

name

true

string

state

true

string

effectiveTime

true

integer (int64)

ruleGiftTime

true

integer (int64)

notie

true

string

3.7. ChargeBill

扣费账单

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

total

true

number (double)

time

true

string

basicBill

true

number (double)

subUserName

true

string

functionBill

true

number (double)

3.8. HireRate

话务租用

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

name

true

string

nextRateTime

true

integer (int64)

chargeUnit

true

string

3.9. BasicBill

基础消费账单

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

total

true

integer (int64)

day_seat

true

integer (int64)

id

true

integer (int64)

daily_symbol

true

integer (int64)

day_callin

true

integer (int64)

day_callout

true

integer (int64)

day_intvoice

true

integer (int64)

day_sms

true

integer (int64)

3.10. CustomApplication

应用

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

uid

true

integer (int64)

id

true

integer (int64)

name

true

string

pid

true

integer (int64)

3.11. OpLogSubUser

操作日志

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

uid

true

integer (int64)

id

true

integer (int64)

time

true

integer (int64)

opdescribe

true

string

subUserName

false

string

3.12. FunBill

功能消费账单

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

day_account

true

integer (int64)

id

true

integer (int64)

daily_symbol

true

integer (int64)

name

true

string

3.13. SubUserRole

子帐号及其角色信息

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

id

true

integer (int64)

jobnumber

false

string

name

true

string

state

true

integer (int64)

account

true

string

roleName

true

string

3.14. Notice

公告

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

uid

企业ID

true

integer (int64)

createtime

创建时间

true

integer (int64)

content

公告内容

true

string

id

公告ID

false

integer (int64)

title

标题

true

string

targets

目标帐号ID(多值以","隔开)

true

string

3.15. Role

角色

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

uid

true

integer (int64)

id

true

integer (int64)

level

true

integer (int64)

name

true

string

3.16. RuleRate

基本费率标准

<colgroup><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"><col style="width: 20%;"></colgroup> <thead> </thead>

参数名

描述

是否必填

数据类型

默认值

name

true

string

ruleId

true

integer (int64)

chargeUnit

false

string