设备成员管理

更新时间:2023-09-15 10:16:57下载pdf

API 列表

action 描述
deviceUser.add 新增用户
deviceUser.edit 修改用户
deviceUser.delete 删除用户
deviceUser.info 查询用户信息
deviceUser.list 根据设备 ID 查询用户信息

新增用户

接口地址

action:deviceUser.add

请求参数

参数名 参数类型 说明 是否必填
device_id String 设备 ID
nick_name String 用户名称
sex Integer 性别:
  • 1:男
  • 2:女
  • birthday Long 出生年月日
    height Integer 身高(cm)
    weight Integer 体重(g)
    contact String 联系方式

    响应参数

    名称 类型 描述
    t Long 返回时间
    success Boolean 是否成功
    result String 添加的用户 ID

    请求示例

    {
      "action": "deviceUser.add",
      "params": {
        "device_id": "vedeo787322q",
        "nick_name": "test",
        "sex": 1
      }
    }
    

    响应示例

    {
        "t":1564996327422,
        "success":true,
        "result": "5121231"
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 《全局错误码》。

    错误码 说明
    500 系统错误

    修改用户

    接口地址

    action: deviceUser.edit
    

    请求参数

    参数名 参数类型 说明 是否必填
    device_id String 设备 ID
    user_id String 添加的用户 ID
    nick_name String 用户名称
    sex Integer 性别:
  • 1:男
  • 2:女
  • birthday Long 出生年月日
    height Integer 身高(cm)
    weight Integer 体重(g)

    响应参数

    名称 类型 描述
    t Long 时间戳
    success Boolean 是否成功
    result Object 结果

    请求示例

    {
      "action": "deviceUser.edit",
      "params": {
        "device_id": "vedeo16236124",
        "user_id": "12445765",
        "nick_name": "test",
        "sex": 1,
        "birthday": 1544996327422,
        "height": 178,
        "weight": 160
      }
    }
    

    响应示例

    {
        "t":1564996327422,
        "success":true,
        "result": true
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 《全局错误码》。

    错误码 说明
    500 系统错误

    删除用户

    接口地址

    action: deviceUser.delete
    

    请求参数

    参数名 参数类型 说明 是否必填
    device_id String 设备 ID
    user_id String 用户 ID

    响应参数

    名称 类型 描述
    t Long 时间戳
    success Boolean 是否成功
    result Boolean 结果

    请求示例

    {
      "action": "deviceUser.delete",
      "params": {
        "device_id": "vedeo16236124",
        "user_id": "5232342"
      }
    }
    

    响应示例

    {
        "t":1564996327422,
        "success":true,
        "result": true
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 《全局错误码》。

    错误码 说明
    500 系统错误

    查询用户信息

    接口地址

    action: deviceUser.info
    

    请求参数

    参数名 参数类型 说明 是否必填
    device_id String 设备 ID
    user_id String 用户 ID

    响应参数

    名称 类型 描述
    t Long 时间戳
    success Boolean 是否成功
    result Object 结果

    result 说明

    参数名 参数类型 说明
    device_id String 设备 ID
    nick_name String 用户名称
    sex Integer 性别:
  • 1:男
  • 2:女
  • birthday Long 出生年月日
    height Integer 身高(cm)
    weight Integer 体重(g)
    contact String 联系方式

    请求示例

    {
      "action": "deviceUser.info",
      "params": {
        "device_id": "vedeo16236124",
        "user_id": "5232342"
      }
    }
    

    响应示例

    {
        "t":1564996327422,
        "success":true,
        "result":
          {
            "device_id": "vedeo16236124",
            "nick_name": "",
            "sex": 1,
            "birthday": 1544996327422,
            "height": 178,
            "weight": 160,
            "contact": ""
          }
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 《全局错误码》。

    错误码 说明
    500 系统错误

    根据设备 ID 查询用户信息

    接口地址

    action: deviceUser.list
    

    请求参数

    参数名 参数类型 说明 是否必填
    device_id String 设备 ID

    响应参数

    名称 类型 描述
    t Long 时间戳
    success Boolean 是否成功
    result List 结果

    result 说明

    参数名 参数类型 说明
    device_id String 设备 ID
    nick_name String 用户名称
    sex Integer 性别:
  • 1:男
  • 2:女
  • birthday Long 出生年月日
    height Integer 身高(cm)
    weight Integer 体重(g)
    contact String 联系方式

    请求示例

    {
      "action": "deviceUser.list",
      "params": {
        "device_id": "vedeo16236124"
      }
    }
    

    响应示例

    {
        "t":1564996327422,
        "success":true,
        "result": [
          {
            "device_id": "vedeo16236124",
            "nick_name": "",
            "sex": 1,
            "birthday": 1544996327422,
            "height": 178,
            "weight": 160,
            "contact": ""
          }
        ]
    }
    

    错误码

    以下为该接口常见的业务异常。更多的异常错误,请参见 《全局错误码》。

    错误码 说明
    500 系统错误