用户工具

站点工具


open:vhall_api_for_测试_2.3.4

*vhall_api_for_测试_2.3.4

user/get-child-list 获取子账号列表

获取子账号列表

URL http://e.vhall.com/api/vhallapi/v2/user/get-child-list

请求参数

参数名 类型 必选 说明
source int 子账号创建来源,1为从微吼平台创建,2为通过接口创建,默认获取全部

响应参数

返回形如{“code”:200,”msg”:“success”,”data”:{}}的json。data部分数据如下:

参数名 类型 说明
user_id int 子账号的微吼用户id
source int 1为从微吼平台创建,2为通过接口创建
res_type int 用量类型,1为流量,2为并发
assign_mode int 用量分配方式,1为固定,2为动态
assign float 具体分配的并发或流量数,如assign_mode是2则不返回此参数

响应示例

{
      "code": "200",
      "msg": "成功",
      "data": [
          {
              "user_id": 981,
              "name": "xxxx",
              "source": 2,
              "res_type": 1,
              "assign_mode": 1,
              "assign": 0
          },
          {
              "user_id": 982,
              "name": "木木的子账号",
              "source": 2,
              "res_type": 1,
              "assign_mode": 1,
              "assign": 50
          }
      ]
  }

错误码

code说明
10819 无子账号数据
10820 当前主账号不是会员

user/get-user-info 获取用户信息

获取用户信息,支持获取接口创建的用户以及微吼平台添加的子账号

URL http://e.vhall.com/api/vhallapi/v2/user/get-user-info

请求参数

参数名类型必选说明
user_id string 微吼用户id
fields string 需要获取的字段,字段之间用英文逗号,分割

fields 参数详情

字段名 说明
name string 用户昵称
head string 用户头像的网络路径
customized_field string 第三方用户创建接口中传入的字段

响应参数

返回形如 { “code”: “200”, “msg”: “成功”, “data”: {} }的json。data部分数据如下:

参数名类型说明
name string 用户昵称
head string 用户头像的网络路径,不传则返回微吼默认头像地址
customized_field string API用户自己定义的一个字段,长度小于255个字符
customized_value string 上述自定义字段的值

响应示例

  {
      "code": "200",
      "msg": "成功",
      "data": {
          "name": "xxxx",
          "head": "",
          "customized_field": "",
          "customized_value": ""
      }
  }

错误码

code说明
10103 第三方用户对象不存在

user/user/change-user-power 更改用户信息

更改用户信息,支持更改接口创建的用户以及微吼平台添加的子账号

错误码

code说明
10830非第三方用户不能更改子账号选项

user/user/get-user-power 更改用户信息

查询用户信息,支持查询接口创建的用户以及微吼平台添加的子账号

错误码

code说明
10831 当前查询数据非子账号数据拥有者

user/register 第三方创建用户

第三方创建用户

URL http://e.vhall.com/api/vhallapi/v2/user/register

请求参数

参数名类型必选说明
third_user_id string 第三方用户ID,做为SDK DEMO里的帐号
pass string 用户密码,做为SDK DEMO里的密码
phone string 用户手机号
name string 用户昵称
email string 用户邮箱
head string 用户头像网络路径
customized_fieldstring API用户自己定义的一个字段,长度小于255个字符
customized_valuestring 上述自定义字段的值

响应参数

返回形如 {“code”:200,”msg”:“success”,”data”:{“user_id”:“799”}}的json,data值的数据格式如下

参数名类型必选说明
user_id int 微吼用户ID

响应示例

{
    "code": 200,
    "msg": "success",
    "data": {
        "user_id": "799"
    }
}

错误码

code说明
10070 第三方用户ID不能为空
10073 手机格式不对
10074 该手机号已存在
10076 邮箱格式不对
10077 密码不能为空
10078 密码为6-20位
10079 该邮箱已存在
10833 自定义字段过长
10834 自定义值过长

user/update 第三方更新用户

第三方更新用户

URL http://e.vhall.com/api/vhallapi/v2/user/update

请求参数

参数名类型必选说明
third_user_id string 第三方用户ID
pass string 更新密码
phone string 更新手机号
name string 更新昵称
email string 更新邮箱
head string 更新头像网络路径
customized_fieldstring API用户自己定义的一个字段,长度小于255个字符
customized_valuestring 上述自定义字段的值

响应参数

返回形如 {“code”:200,”msg”:“success”,”data”:{“user_id”:“799”}}的json,data值的数据格式如下

参数名类型必选说明
user_id int 微吼用户ID

响应示例

{
  "code": 200,
  "msg": "success",
  "data": {
    "id": 837
  }
}

错误码

code说明
10102 第三方用户ID不能为空
10103 第三方用户对象不存在
10833 自定义字段过长
10834 自定义值过长
open/vhall_api_for_测试_2.3.4.txt · 最后更改: 2017/03/28 10:55 由 kun.wang