用户服务

更新时间：2018-05-28 16:11:48

   提供一组与用户相关的服务接口，客户端应用通过本组服务接口可以实现用户绑定设备列表信息的获取，同时可以实现设备和push通道的解绑操作。

==apiVer使用最新的版本，当前为1.0.2==

获取用户绑定的设备列表

定义描述

path 版本 描述 是否需要登陆
/uc/listBindingByAccount $apiVer 根据用户获取设备列表 是

请求参数

参数 类型 必填 描述
pageNo Int 是 当前页号，从1开始的页序号
pageSize Int 是 页大小，单页的item数量上限
thingType String 否 设备类型:"VIRTUAL", "WEB", "APP","DEVICE"
nodeType String 否 设备的节点类型:"DEVICE", "GATEWAY"
owned Int 否 表示绑定类型：0:被分享的设备；1:拥有的设备；null:所有

返回参数

参数 类型 描述
total Integer 云端总数
pageNo Integer 当前页号
pageSize Integer 页大小
data List< AccountDevDTO > 设备列表
AccountDevDTO.identityId String 用户的身份ID
AccountDevDTO.iotId String 设备的iotId
AccountDevDTO.productKey String 设备的productKey
AccountDevDTO.deviceName String 设备的deviceName
AccountDevDTO.productName String 设备的产品名称
AccountDevDTO.productImage String 设备的产品图片
AccountDevDTO.productModel String 设备的产品型号
AccountDevDTO.categoryImage String 品类图标
AccountDevDTO.nickName String 用户对设备的昵称，用户通过setDeviceNickName设置的昵称
AccountDevDTO.netType String 设备入网类型
AccountDevDTO.thingType String 设备的类型:"VIRTUAL", "WEB", "APP","DEVICE"
AccountDevDTO.nodeType String 设备的节点类型:"DEVICE", "GATEWAY"
AccountDevDTO.status Byte 设备的状态
AccountDevDTO.owned Byte 0:分享者；1：拥有者
AccountDevDTO.identityAlias String 用户的显示名(mobile或loginName或email)
AccountDevDTO.gmtModified Date 修改时间(绑定时间)

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "pageNo":1,
        "pageSize":10
    },
    "version": "1.0"
}

正常返回示例

{
  "code": 200,
  "data": [
    {
      "productModel": "testProduct",
      "iotId": "fy2Z1oZFWZQVii6kkFVM00101edf00",
      "netType": "NET_WIFI",
      "identityId": "5082opabf5192fb1ae453eced9806fbdae6f6093",
      "thingType": "DEVICE",
      "nodeType": "DEVICE",
      "productKey": "a1OwEjYFJNb",
      "deviceName": "b65cb59e688e4f74a208592cd695fb",
      "productName": "0d2a0e6195",
      "status": 3
    },
    {
      "productModel": "testProduct",
      "iotId": "wW4uJnjdxISy7QbzUYKS0010ddb200",
      "netType": "NET_WIFI",
      "identityId": "5082opabf5192fb1ae453eced9806fbdae6f6093",
      "thingType": "DEVICE",
      "nodeType": "DEVICE",
      "productKey": "a1Btn9lxeJg",
      "deviceName": "b824b648947c40e6beb378f4f17e90",
      "productName": "07b5962ae7",
      "status": 3
    }
  ],
  "id": "e2d74ffe-308e-44ee-94a5-9b44a43eabc9"
}

错误码

错误码 错误信息 来源 详细描述
200 success 系统 成功
400 request error. 系统 请求错误
401 request auth error. 系统 请求认证错误
403 request forbidden. 系统 请求被禁止
404 service not found. 系统 服务未找到
429 too many requests. 系统 太多请求
460 request parameter error. 系统 请求参数错误
500 service error. 系统 服务端错误
503 service not available. 系统 服务不可用

根据设备获取绑定关系

定义描述

path 版本 描述 是否需要登陆
/uc/listBindingByDev $apiVer 根据设备获取绑定关系 是

请求参数

参数 类型 必填 描述
iotId String 是 设备id
pageNo Int 是 当前页号，从1开始的页序号
pageSize Int 是 页大小，单页的item数量上限
owned Int 否 表示设备绑定的类型：0:作为分享设备被他人分享；1:设备拥有者；null:所有

返回参数

参数 类型 描述
total Integer 云端总数
pageNo Integer 当前页号
pageSize Integer 页大小
data List< AccountDevDTO > 查询到的用户设备列表
AccountDevDTO.identityId String 用户的身份ID
AccountDevDTO.iotId String 设备的iotId
AccountDevDTO.productKey String 设备的productKey
AccountDevDTO.deviceName String 设备的deviceName
AccountDevDTO.productName String 设备的产品名称
AccountDevDTO.productImage String 设备的产品图片
AccountDevDTO.productModel String 设备的产品型号
AccountDevDTO.categoryImage String 品类图标
AccountDevDTO.nickName String 用户对设备的昵称，用户通过setDeviceNickName设置的昵称
AccountDevDTO.netType String 设备入网类型
AccountDevDTO.thingType String 设备的类型:"VIRTUAL", "WEB", "APP","DEVICE"
AccountDevDTO.nodeType String 设备的节点类型:"DEVICE", "GATEWAY"
AccountDevDTO.status Byte 设备的状态
AccountDevDTO.owned Byte 0:分享者；1：拥有者
AccountDevDTO.identityAlias String 用户的显示名(mobile或loginName或email)
AccountDevDTO.gmtModified Date 修改时间(绑定时间)
AccountDevDTO.description String 描述

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.1.0"
    },
    "id": 1508212818676,
    "params": {
        "pageNo":1,
        "pageSize":10,
        "iotId":"fy2Z1oZFWZQVii6kkFVM00101edf00"

    },
    "version": "1.0"
}

正常返回示例

{
  "code": 200,
  "data": [
    {
      "productModel": "testProduct",
      "iotId": "fy2Z1oZFWZQVii6kkFVM00101edf00",
      "netType": "NET_WIFI",
      "identityId": "5082opabf5192fb1ae453eced9806fbdae6f6093",
      "thingType": "DEVICE",
      "nodeType": "DEVICE",
      "productKey": "a1OwEjYFJNb",
      "deviceName": "b65cb59e688e4f74a208592cd695fb",
      "productName": "0d2a0e6195",
      "status": 3
    }
  ],
  "id": "e2d74ffe-308e-44ee-94a5-9b44a43eabc9"
}

错误码

错误码 错误信息 来源 详细描述
200 success 系统 成功
400 request error. 系统 请求错误
401 request auth error. 系统 请求认证错误
403 request forbidden. 系统 请求被禁止
404 service not found. 系统 服务未找到
429 too many requests. 系统 太多请求
460 request parameter error. 系统 请求参数错误
500 service error. 系统 服务端错误
503 service not available. 系统 服务不可用

设备列表排序

定义描述

path 版本 描述 是否需要登陆
/uc/sortDevices $apiVer 对设备进行排序 是

请求参数

参数 类型 必填 描述
groupId String 否 要排序的空间（如家ID等）. 可为空
sortDeviceDTOList List< SortDeviceDTO > 是 设备排序有变化的数据
SortDeviceDTO.iotId String 是 设备ID
SortDeviceDTO.fromOrder Integer 是 排序变化前设备的位置
SortDeviceDTO.toOrder Integer 是 排序变化后设备的位置

返回参数

参数 类型 描述

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述

生成分享用的二维码

定义描述

path 版本 描述 是否需要登陆
/uc/generateShareQrCode $apiVer 生成设备分享用的二维码，支持批量设备和场景 是

请求参数

参数 类型 必填 描述
iotIdList List< String > 否 设备iotId列表（iotIdList和sceneIdList不能同时为空）
sceneIdList List< String > 否 场景sceneId列表（iotIdList和sceneIdList不能同时为空）
groupId String 否 设备和场景所在的空间（如家ID等）. 可为空

返回参数

参数 类型 描述
qrKey String 生成的二维码key

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.1.0"
    },
    "id": 1508212818676,
    "params": {
        "iotIdList":["xxxx"],
        "sceneIdList":["xxxx"]
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "data": {
        "qrKey": "xxxxxx"
    },
    "id": "6ec222eb-87fc-421e-9b67-351df196ceb3"
}

错误码

错误码 错误信息 来源 详细描述
200 success 系统 成功
400 request error. 系统 请求错误
401 request auth error. 系统 请求认证错误
403 request forbidden. 系统 请求被禁止
404 service not found. 系统 服务未找到
429 too many requests. 系统 太多请求
460 request parameter error. 系统 请求参数错误
500 service error. 系统 服务端错误
503 service not available. 系统 服务不可用
2065 identityId and iotId not bound 业务 设备和账号未绑定
2066 identityId is not manager 业务 该用户不是设备的管理员
2073 this product not support share 业务 该设备的分享模式不支持生成二维码

通过扫描二维码绑定设备

定义描述

path 版本 描述 是否需要登陆
/uc/scanBindByShareQrCode $apiVer 通过扫描二维码绑定设备，绑定后是普通成员 是

请求参数

参数 类型 必填 描述
qrKey String 是 扫描的二维码key

返回参数

参数 类型 描述

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "qrKey":"xxxx"
    },
    "version": "1.0"
}

正常返回示例

错误码

错误码 错误信息 来源 详细描述
200 success 系统 成功
400 request error. 系统 请求错误
401 request auth error. 系统 请求认证错误
403 request forbidden. 系统 请求被禁止
404 service not found. 系统 服务未找到
429 too many requests. 系统 太多请求
460 request parameter error. 系统 请求参数错误
500 service error. 系统 服务端错误
503 service not available. 系统 服务不可用
2073 this product not support share 业务 该设备的分享模式不支持生成二维码

设备分享给指定的用户

定义描述

path 版本 描述 是否需要登陆
/uc/shareDevicesAndScenes $apiVer 将设备分享给指定的用户 是

请求参数

参数 类型 必填 描述
iotIdList List< String > 是 设备iotId列表
accountAttr String 是 唯一标识目标用户的属性（如：手机号、邮箱的值）
accountAttrType String 是 唯一标识目标用户的属性类型（如：手机号、邮箱等），手机号："MOBILE"，邮箱: "EMAIL"

返回参数

参数 类型 描述

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述

获取共享通知列表

定义描述

path 版本 描述 是否需要登陆
/uc/getShareNoticeList $apiVer 获取共享通知列表 是

请求参数

参数 类型 必填 描述
pageNo Int 是 当前页号，从1开始的页序号
pageSize Int 是 页大小，单页的item数量上限

返回参数

参数 类型 描述
total Integer 云端总量
pageNo Integer 当前页号
pageSize Integer 页大小
shareNoticeList List< ShareNoticeDTO > 分享列表
ShareNoticeDTO.initiatorAlias String 发起分享用户别名
ShareNoticeDTO.receiverAlias String 被分享用户别名
ShareNoticeDTO.targetId String 共享的物的ID
ShareNoticeDTO.targetType String 共享的物的类型
ShareNoticeDTO.productImage String 设备产品图片
ShareNoticeDTO.deviceName String 设备的deviceName
ShareNoticeDTO.isReceiver Integer 当前用户是否是消息接收者
ShareNoticeDTO.gmtCreate Long 创建时间
ShareNoticeDTO.gmtModified Long 修改时间
ShareNoticeDTO.recordId String 分享记录唯一标识
ShareNoticeDTO.status Integer 状态: -1: 初始化; 0:同意; 1:拒绝; 2:取消; 3:过期; 4:抢占; 5:删除; 6:发起者已解绑; 99:异常
ShareNoticeDTO.description String 描述
ShareNoticeDTO.categoryImage String 品类图标
ShareNoticeDTO.productName String 产品名称
ShareNoticeDTO.nickName String 设备昵称，客户端@归空@张霄@王春涛要求展示时优先使用用户自己通过setDeviceNickName接口设置的nickName而加的 @2018-05-14

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述

发起者取消分享

定义描述

path 版本 描述 是否需要登陆
/uc/cancelShare $apiVer 发起者取消分享 是

请求参数

参数 类型 必填 描述
recordIdList List< String > 是 分享记录列表

返回参数

参数 类型 描述

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述

被分享者同意/拒绝分享

定义描述

path 版本 描述 是否需要登陆
/uc/confirmShare $apiVer 被分享者同意/拒绝分享 是

请求参数

参数 类型 必填 描述
recordIdList List< String > 是 分享记录列表
agree Integer 是 0:不同意；1:同意. 必填

返回参数

参数 类型 描述

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述

设置设备昵称

定义描述

path 版本 描述 是否需要登陆
/uc/setDeviceNickName $apiVer 设置设备昵称 是

请求参数

参数 类型 必填 描述
groupId String 否 设备的空间（如家ID等）
iotId String 是 设备ID
nickName String 是 昵称

返回参数

参数 类型 描述

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述

解绑用户和设备

定义描述

path 版本 描述 是否需要登陆
/uc/unbindAccountAndDev $apiVer 解绑用户和设备。若用户不是拥有者(管理员)，则只解绑自己；若用户是拥有者(管理员)，则再解绑与该设备绑定的所有用户。若用户是管理员且设备是网关，则还会解绑用户和其所有的子设备。 是

请求参数

参数 类型 必填 描述
iotId String 否 设备ID

返回参数

参数 类型 描述

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "iotId":"xxxx"
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
}

错误码

错误码 错误信息 来源 详细描述
200 success 系统 成功
400 request error. 系统 请求错误
401 request auth error. 系统 请求认证错误
403 request forbidden. 系统 请求被禁止
404 service not found. 系统 服务未找到
429 too many requests. 系统 太多请求
460 request parameter error. 系统 请求参数错误
500 service error. 系统 服务端错误
503 service not available. 系统 服务不可用

查询用户和设备的关系

定义描述

path 版本 描述 是否需要登陆
/uc/getByAccountAndDev $apiVer 查询用户和设备的关系. 如不存在, 返回一个空对象. 是

请求参数

参数 类型 必填 描述
iotId String 是 设备ID

返回参数

参数 类型 描述
identityId String 用户的身份ID
iotId String 设备的iotId
AproductKey String 设备的productKey
deviceName String 设备的deviceName
productName String 设备的产品名称
productImage String 设备的产品图片
productModel String 设备的产品型号
nickName String 用户对设备的昵称
netType String 设备入网类型
thingType String 设备的类型:"VIRTUAL", "WEB", "APP","DEVICE"
nodeType String 设备的节点类型:"DEVICE", "GATEWAY"
status Byte 设备的状态
owned Byte 0:分享者；1：拥有者
identityAlias String 用户的显示名(mobile或loginName或email)
gmtModified Date 修改时间(绑定时间)

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述

管理员解绑设备

定义描述

path 版本 描述 是否需要登陆
/uc/unbindByManager $apiVer 管理员解绑指定的用户和设备。要求当前登录用户是设备的管理员、拥有者。 是

请求参数

参数 类型 必填 描述
targetIdentityId String 是 要解绑的用户（设备的普通成员），不能与identityId相同
iotIdList List< String> 是 要解绑的设备ID列表

返回参数

参数 类型 描述

无

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述

清空共享消息列表

定义描述

path 版本 描述 是否需要登陆
/uc/clearShareNoticeList $apiVer 清空共享消息列表（包括本人发起和接收全部） 是

请求参数

参数 类型 必填 描述

返回参数

参数 类型 描述

无

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述

绑定push通道

定义描述

path 版本 描述 是否需要登陆
/uc/bindPushChannel $apiVer 绑定push通道 是

请求参数

参数 类型 必填 描述
deviceId String 是 push通道的deviceId
deviceType String 是 设备类型：iOS或ANDROID，值由业务方和app协商

返回参数

参数 类型 描述

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "deviceId":"xxxx",
        "deviceType":"iOS"
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
}

错误码

错误码 错误信息 来源 详细描述

解绑push通道

定义描述

path 版本 描述 是否需要登陆
/uc/unbindPushChannel 1.0.0 绑定push通道 是

请求参数

参数 类型 必填 描述
deviceId String 是 push通道的deviceId

返回参数

参数 类型 必有 描述

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.0"
    },
    "id": 1508212818676,
    "params": {
        "deviceId":"xxxx"
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
}

错误码

错误码 错误信息 来源 详细描述
200 success 系统 成功
400 request error. 系统 请求错误
401 request auth error. 系统 请求认证错误
403 request forbidden. 系统 请求被禁止
404 service not found. 系统 服务未找到
429 too many requests. 系统 太多请求
460 request parameter error. 系统 请求参数错误
500 service error. 系统 服务端错误
503 service not available. 系统 服务不可用

获取网关的子设备列表

定义描述

path 版本 描述 是否需要登陆
/subdevices/list $apiVer 获取用户绑定的网关子设备列表 是

请求参数

参数 类型 必填 描述
iotId String 是 设备ID
pageNo Int 是 当前页号，从1开始的页序号
pageSize Int 是 页大小，单页的item数量上限

返回参数

参数 类型 描述
total Integer 云端总数
pageNo Integer 当前页号
pageSize Integer 页大小
data List< DeviceInfoDTO > 子设备列表
DeviceInfoDTO.iotId String 设备的iotId
DeviceInfoDTO.productKey String 设备的productKey
DeviceInfoDTO.deviceName String 设备的deviceName
DeviceInfoDTO.nickName String 设备的产品名称
DeviceInfoDTO.image String 品类图片
DeviceInfoDTO.status Byte 设备的在线状态：0 - 未激活， 1 - 在线， 3 - 离线， 8 - 禁用

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "iotId":"xxxxxxx",
        "pageNo":1,
        "pageSize":10
    },
    "version": "1.0"
}

正常返回示例

{
  "code": 200,
  "data": [
    {
      "iotId": "testIot",
      "productKey": "fy2Z1oZFWZQVii6kkFVM00101edf00",
      "deviceName": "NET_WIFI",
      "nickName": "xxxxxx",
      "image": "http://abc.jpg",
      "status": 0
    },
    {
      "iotId": "testIot",
      "productKey": "fy2Z1oZFWZQVii6kkFVM00101edf00",
      "deviceName": "NET_WIFI",
      "nickName": "xxxxxx",
      "image": "http://abc.jpg",
      "status": 0
    }
  ],
  "id": "e2d74ffe-308e-44ee-94a5-9b44a43eabc9"
}

错误码

错误码 错误信息 来源 详细描述
200 success 系统 成功
400 request error. 系统 请求错误
401 request auth error. 系统 请求认证错误
403 request forbidden. 系统 请求被禁止
404 service not found. 系统 服务未找到
429 too many requests. 系统 太多请求
460 request parameter error. 系统 请求参数错误
500 service error. 系统 服务端错误
503 service not available. 系统 服务不可用

解绑用户和场景

定义描述

path 版本 描述 是否需要登陆
/uc/unbindAccountAndScene $apiVer 解绑用户和场景. 若用户不是场景的拥有者(管理员), 则只解绑自己; 若用户是拥有者(管理员), 则再解绑与该场景绑定的所有用户 是

请求参数

参数 类型 必填 描述
sceneId String 否 场景ID

返回参数

参数 类型 描述

示例

请求示例

正常返回示例

错误码

错误码 错误信息 来源 详细描述
200 success 系统 成功
400 request error. 系统 请求错误
401 request auth error. 系统 请求认证错误
403 request forbidden. 系统 请求被禁止
404 service not found. 系统 服务未找到
429 too many requests. 系统 太多请求
460 request parameter error. 系统 请求参数错误
500 service error. 系统 服务端错误
503 service not available. 系统 服务不可用

results matching ""

    No results matching ""