主题
账户管理
账户详情
| 项目 | 内容 |
|---|---|
| 接口描述 | 账户详情 |
| 接口地址 | /console/v1/account |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
无
响应参数
| name | type | default | desc |
|---|---|---|---|
| account | object | - | desc:账户信息 |
| account.id | int | - | desc:用户ID |
| account.username | string | - | desc:姓名 |
| account.email | string | - | desc:邮箱 |
| account.phone_code | int | - | desc:国际电话区号 |
| account.phone | string | - | desc:手机号 |
| account.company | string | - | desc:公司 |
| account.country_id | int | - | desc:国家ID |
| account.address | string | - | desc:地址 |
| account.language | string | - | desc:语言 |
| account.notes | string | - | desc:备注 |
| account.credit | string | - | desc:余额 |
| account.set_operate_password | bool | - | desc:是否设置了操作密码 |
| account.customfield | object | - | desc:自定义字段 |
| account.customfield.pending_amount | string | - | desc:待审核的提现金额 |
| account.currency_prefix | string | - | desc:货币符号 |
| account.oauth | array | - | desc:三方登录列表 |
| account.oauth[].name | string | - | desc:标识 |
| account.oauth[].title | string | - | desc:名称 |
| account.oauth[].url | string | - | desc:跳转链接 |
| account.oauth[].link | bool | - | desc:是否绑定 |
| account.oauth[].img | string | - | desc:图标地址 |
| account.oauth[].img_unbound | string | - | desc:未绑定图标地址 |
| account.notice_open | int | - | desc:是否接收短信邮件通知 |
| account.notice_method | string | - | desc:通知方式 |
| account.total_credit | float | - | desc:账户余额 |
| account.credit_remind | int | - | desc:余额提醒 |
| account.credit_remind_amount | float | - | desc:余额提醒阈值 |
账户编辑
| 项目 | 内容 |
|---|---|
| 接口描述 | 账户编辑 |
| 接口地址 | /console/v1/account |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| username | string | - | validate:optional | desc:姓名 |
| company | string | - | validate:optional | desc:公司 |
| country_id | int | - | validate:optional | desc:国家ID |
| address | string | - | validate:optional | desc:地址 |
| language | string | - | validate:optional | desc:语言 |
| notes | string | - | validate:optional | desc:备注 |
响应参数
无
验证原手机
| 项目 | 内容 |
|---|---|
| 接口描述 | 验证原手机 |
| 接口地址 | /console/v1/account/phone/old |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| code | string | - | validate:required | desc:验证码 |
响应参数
无
修改手机
| 项目 | 内容 |
|---|---|
| 接口描述 | 修改手机,如果已经绑定了手机需要验证原手机 |
| 接口地址 | /console/v1/account/phone |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| phone_code | int | - | validate:required | desc:国际电话区号 |
| phone | string | - | validate:required | desc:手机号 |
| code | string | - | validate:required | desc:验证码 |
响应参数
无
验证原邮箱
| 项目 | 内容 |
|---|---|
| 接口描述 | 验证原邮箱 |
| 接口地址 | /console/v1/account/email/old |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| code | string | - | validate:required | desc:验证码 |
响应参数
无
修改邮箱
| 项目 | 内容 |
|---|---|
| 接口描述 | 修改邮箱,如果已经绑定了邮箱需要验证原邮箱 |
| 接口地址 | /console/v1/account/email |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| string | - | validate:required | desc:邮箱 | |
| code | string | - | validate:required | desc:验证码 |
响应参数
无
修改密码
| 项目 | 内容 |
|---|---|
| 接口描述 | 修改密码 |
| 接口地址 | /console/v1/account/password |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| old_password | string | - | validate:required | desc:旧密码 |
| new_password | string | - | validate:required | desc:新密码 |
| repassword | string | - | validate:required | desc:确认密码 |
| security_verify_method | string | - | operate_password=操作密码email_code=邮箱验证码phone_code=手机验证码certification=实名校验validate:optional | desc:安全验证方式 |
| security_verify_value | string | - | 操作密码或验证码validate:optional | desc:安全验证值 |
| certify_id | string | - | 实名校验时需要validate:optional | desc:实名认证ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data.need_security_verify | bool | - | desc:是否需要安全验证 |
| data.available_methods | array | - | desc:可用的验证方式列表 |
验证码修改密码
| 项目 | 内容 |
|---|---|
| 接口描述 | 验证码修改密码 |
| 接口地址 | /console/v1/account/password/code |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| type | string | - | phone手机email邮箱validate:required | desc:验证类型 |
| code | string | - | validate:required | desc:验证码 |
| password | string | - | validate:required | desc:密码 |
| re_password | string | - | validate:required | desc:重复密码 |
响应参数
无
注销
| 项目 | 内容 |
|---|---|
| 接口描述 | 注销 |
| 接口地址 | /console/v1/logout |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
无
响应参数
无
余额变更记录列表
| 项目 | 内容 |
|---|---|
| 接口描述 | 余额变更记录列表 |
| 接口地址 | /console/v1/credit |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| start_time | int | - | 时间戳svalidate:optional | desc:开始时间 |
| end_time | int | - | 时间戳svalidate:optional | desc:结束时间 |
| type | string | - | Artificial人工Recharge充值Applied应用至订单Refund退款Withdraw提现validate:optional | desc:类型 |
| keywords | string | - | 记录ID或备注validate:optional | desc:关键字 |
| order_id | int | - | validate:optional | desc:订单ID |
| page | int | 1 | validate:optional | desc:页数 |
| limit | int | 10 | validate:optional | desc:每页条数 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | desc:记录列表 |
| list[].id | int | - | desc:记录ID |
| list[].type | string | - | desc:类型 |
| list[].amount | string | - | desc:金额 |
| list[].notes | string | - | desc:备注 |
| list[].create_time | int | - | desc:变更时间 |
| list[].admin_name | string | - | desc:管理员名称 |
| count | int | - | desc:记录总数 |
| page_total_amount | string | - | desc:当前页金额总计 |
| total_amount | string | - | desc:金额总计 |
修改操作密码
| 项目 | 内容 |
|---|---|
| 接口描述 | 修改操作密码 |
| 接口地址 | /console/v1/account/operate_password |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| origin_operate_password | string | - | 已有操作密码必传validate:optional | desc:原操作密码 |
| operate_password | string | - | validate:required | desc:新操作密码 |
| re_operate_password | string | - | validate:required | desc:重复操作密码 |
| security_verify_method | string | - | operate_password=操作密码email_code=邮箱验证码phone_code=手机验证码certification=实名校验validate:optional | desc:安全验证方式 |
| security_verify_value | string | - | 操作密码或验证码validate:optional | desc:安全验证值 |
| certify_id | string | - | 实名校验时需要validate:optional | desc:实名认证ID |
响应参数
| name | type | default | desc |
|---|---|---|---|
| data.need_security_verify | bool | - | desc:是否需要安全验证 |
| data.available_methods | array | - | desc:可用的验证方式列表 |
用户流量预警详情
| 项目 | 内容 |
|---|---|
| 接口描述 | 用户流量预警详情 |
| 接口地址 | /console/v1/account/traffic_warning |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| module | string | - | mf_cloud=魔方云mf_dcim=DCIMvalidate:required | desc:模块标识 |
响应参数
| name | type | default | desc |
|---|---|---|---|
| warning_switch | int | - | desc:预警开关 |
| leave_percent | int | - | desc:预警百分比 |
保存用户流量预警
| 项目 | 内容 |
|---|---|
| 接口描述 | 保存用户流量预警 |
| 接口地址 | /console/v1/account/traffic_warning |
| 请求方式 | PUT |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| module | string | - | mf_cloud=魔方云mf_dcim=DCIMvalidate:required | desc:模块标识 |
| warning_switch | int | - | 0=关闭1=开启validate:required | desc:预警开关 |
| leave_percent | int | - | 5101520关闭传0validate:required | desc:预警百分比 |
响应参数
无
冻结记录
| 项目 | 内容 |
|---|---|
| 接口描述 | 冻结记录 |
| 接口地址 | /console/v1/account/credit/freeze |
| 请求方式 | GET |
| 接口版本 | v1 |
请求参数
无
响应参数
| name | type | default | desc |
|---|---|---|---|
| list | array | - | desc:冻结记录列表 |
| list[].id | int | - | desc:冻结记录ID |
| list[].amount | float | - | desc:冻结金额 |
| list[].client_notes | string | - | desc:备注 |
| list[].create_time | int | - | desc:冻结时间 |
| list[].nickname | string | - | desc:操作人 |
| count | int | - | desc:记录总数 |
余额提醒
| 项目 | 内容 |
|---|---|
| 接口描述 | 余额提醒 |
| 接口地址 | /console/v1/account/credit/remind |
| 请求方式 | POST |
| 接口版本 | v1 |
请求参数
| name | type | default | validate | desc |
|---|---|---|---|---|
| credit_remind | int | - | 0关闭1开启validate:required | desc:余额提醒 |
| credit_remind_amount | float | - | validate:optional | desc:余额提醒阈值 |
响应参数
无