用户服务

更新时间：2019-09-05 10:50:00

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

用户和设备绑定关系

• 获取用户绑定的设备列表

• 根据设备获取绑定关系

• 设备列表排序

• 获取网关的子设备列表

• 查询用户和设备的关系

• 解绑用户和设备

• 管理员解绑设备

设备分享

• 生成分享用的二维码

• 通过扫描二维码绑定设备

• 设备分享给指定的用户

• 获取共享通知列表

• 发起者取消分享

• 被分享者同意或拒绝分享

• 设置设备昵称

• 清空共享消息列表

用户和消息绑定关系

• 绑定push通道

• 解绑push通道

虚拟用户

• 创建虚拟用户

• 删除虚拟用户

• 更新虚拟用户信息

• 查询虚拟用户列表

• 查询虚拟用户详情

获取用户绑定的设备列表

定义描述

请求参数

返回参数

示例

请求示例

{
    "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"
}

异常返回示例

{
 "code":2000,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"iotId is blank!"
}

错误码

请参考公共错误码

根据设备获取绑定关系

定义描述

请求参数

返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "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"
}

异常返回示例

{
 "code":2064,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"need authorize to bind"
}

错误码

请参考公共错误码

设备列表排序

定义描述

请求参数

返回参数

无业务返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "groupId":"",
        "sortDeviceDTOList":[
            {"iotId": "Z75bTa4dYNLxj1Y3SeRW001056af10",
              "fromOrder": 1,
              "toOrder":  3            
            },
            {"iotId": "faHSHCOxsZGWxdEHbQoN00108dcf00",
              "fromOrder": 2,
              "toOrder":  1            
            },
            {"iotId": "Spb4eatt1LtRY7VxWdeq00108a4410",
              "fromOrder": 3,
              "toOrder":  2            
            }
         ] 
    },
    "version": "1.0"
}

正常返回示例

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

异常返回示例

{
 "code":2000,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"sortDevice param error!"
}

错误码

请参考公共错误码

生成分享用的二维码

定义描述

请求参数

返回参数

示例

请求示例

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

正常返回示例

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

异常返回示例

{
  "code":2081,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"scene not found by sceneId"
}

错误码

请参考公共错误码

通过扫描二维码绑定设备

定义描述

请求参数

返回参数

ScanShareQrCodeV2Res结构

示例

请求示例

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

正常返回示例

{
    "code": 200,
    "data": {
    "iotIdList":["abc","123"]
    },
    "id":"bb179e80-39fd-4a79-ba97-48ca87a3f5c5"
}

异常返回示例

{
 "code":2067,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"qrKey not exist"
}

错误码

请参考公共错误码

设备分享给指定的用户

定义描述

请求参数

返回参数

无业务返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "accountAttr":"13656637684",
        "accountAttrType": "MOBILE",
         "iotIdList":[
                        "inqfGrp0Cu5IRelvqdpD00100fd600",
                        "ETytXLwjIMRZK0GFW4qG0010629e00"   
                     ]
    },
    "version": "1.0"
}

正常返回示例

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

异常返回示例

{
 "code":2064,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"need authorize to bind"
}

错误码

获取共享通知列表

定义描述

请求参数

返回参数

示例

请求示例

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

正常返回示例

{
  "code": 200,
  "data": [
    {
      "gmtCreate": "15275845255",
      "gmtModified": "15235845255",
      "targetId": "fy2Z1oZFWZQVii6kkFVM00101edf00",
      "categoryImage": "http://xxx",
      "description": "向15163587365共享设备中，待对方确认",
      "targetType": "DEVICE",
      "recordId": "a1OwEjY1d555d5dfdFJNb",
      "deviceName": "b65cb59e688e4f74a208592cd695fb",
      "productName": "0d2a0e6195",
      "initiatorAlias":"15632547896",
      "receiverAlias":"15163587365",
      "isReceiver": 0,
      "status": -1
    }
  ],
  "id": "e2d74ffe-308e-44ee-94a5-9b44a43eabc9"
}

异常返回示例

{
 "code":2062,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"identityId not exist"
}

错误码

请参考公共错误码

发起者取消分享

定义描述

请求参数

返回参数

无业务返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
         "recordIdList":[
                        "d4eb352adac248be91fb61d53febd503",
                        "2568degt2adac248be91fb61d53febd3"   
                     ]
    },
    "version": "1.0"
}

正常返回示例

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

异常返回示例

{
  "code":2093,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"forbidden to repeat cancel sharing."
}

错误码

被分享者同意或拒绝分享

定义描述

请求参数

返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
         "recordIdList":[
                        "d4eb352adac248be91fb61d53febd503",
                        "2568degt2adac248be91fb61d53febd3"   
                     ],
        "agree":1
    },
    "version": "1.0"
}

正常返回示例

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

异常返回示例

{
 "code":2092,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"forbidden to repeat reject sharing."
}

错误码

请参考公共错误码

设置设备昵称

定义描述

请求参数

返回参数

无业务返回参数

示例

请求示例

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

正常返回示例

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

异常返回示例

{
  "code":2062,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"identityId not exist"
}

错误码

请参考公共错误码

解绑用户和设备

定义描述

请求参数

返回参数

无业务返回参数

示例

请求示例

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

正常返回示例

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

异常返回示例

{
  "code":2062,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"identityId not exist"
}

错误码

请参考公共错误码

查询用户和设备的关系

定义描述

请求参数

返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "iotId":"xxxx"
    },
    "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"
}

异常返回示例

{
 "code":2063,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"iotId not exist"
}

错误码

请参考公共错误码

管理员解绑设备

定义描述

请求参数

返回参数

无业务返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
        "targetIdentityId":"xxxx",
        "iotIdList":[
                        "d4eb352adac248be91fb61d53febd503",
                        "2568degt2adac248be91fb61d53febd3"   
                     ]
    },
    "version": "1.0"
}

正常返回示例

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

异常返回示例

{
 "code":2083,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"you are not the manager of some devices"
}

错误码

请参考公共错误码

清空共享消息列表

定义描述

请求参数

无业务请求参数

返回参数

无业务返回参数

无

示例

请求示例

{
    "request": {
        "iotToken": "c4b3f642a91880195a5e7a06a3c5dcb3",
        "apiVer": "1.0.2"
    },
    "id": 1508212818676,
    "params": {
    },
    "version": "1.0"
}

正常返回示例

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

异常返回示例

{
 "code":2062,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"identityId not exist"
}

错误码

请参考公共错误码

绑定push通道

定义描述

请求参数

返回参数

无业务返回参数

示例

请求示例

{
    "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"
}

异常返回示例

{
 "code":2062,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"identityId not exist"
}

错误码

请参考公共错误码

解绑push通道

定义描述

请求参数

返回参数

无业务返回参数

示例

请求示例

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

正常返回示例

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

异常返回示例

{
 "code":2062,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"identityId not exist"
}

错误码

请参考公共错误码

获取网关的子设备列表

定义描述

请求参数

返回参数

示例

请求示例

{
    "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"
}

异常返回示例

{
 "code":2062,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"请求错误",
 "message":"identityId not exist"
}

错误码

请参考公共错误码

创建虚拟用户

定义描述

请求参数

attrList列表结构

返回参数

attrList列表结构

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.4"
    },
    "id": 1508212818676,
    "params": {
        "attrList": [
              {
                 "attrKey":"name",
                 "attrValue":"小明"
              }
        ]
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "userId":"10B6336EFE05374FF99BDD428F58AA5A18",
        "attrList":[
            {
               "attrKey":"name",
               "attrValue":"小明"
            }
        ]
    }
}

异常返回示例

{
 "code":503,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}

错误码

请参考公共错误码

删除虚拟用户

定义描述

请求参数

返回参数

无业务返回参数

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.4"
    },
    "id": 1508212818676,
    "params": {
           "userId":"10B6336EFE05374FF99BDD428F58AA5A18"
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": null
}

异常返回示例

{
 "code":503,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}

错误码

更新虚拟用户信息

定义描述

请求参数

attrList列表结构

返回参数

attrList列表结构

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.4"
    },
    "id": 1508212818676,
    "params": {
           "userId":"10B6336EFE05374FF99BDD428F58AA5A18",
           "opType":2,
           "attrList":[
               {
                    "attrKey":"name",
                    "attrValue":"小李"
               }
           ]
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "userId":"10B6336EFE05374FF99BDD428F58AA5A18",
        "attrList":[
            {
               "attrKey":"name",
               "attrValue":"小明"
            }
        ]
    }
}

异常返回示例

{
 "code":503,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}

错误码

查询虚拟用户列表

定义描述

请求参数

返回参数

data列表结构

attrList列表结构

示例

请求示例

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

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": {
        "total":1,
        "pageNo":1,
        "pageSize":10,
        "data":[
            {
                "userId":"10B6336EFE05374FF99BDD428F58AA5A18",
                "attrList":[
                   {
                       "attrKey":"name",
                       "attrValue":"小明"
                   }
                ]
            }
        ]
    }
}

异常返回示例

{
 "code":503,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}

错误码

请参考公共错误码

查询虚拟用户详情

定义描述

请求参数

返回参数

attrList列表结构

示例

请求示例

{
    "request": {
        "iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
        "apiVer": "1.0.4"
    },
    "id": 1508212818676,
    "params": {
           "userId":"10B6336EFE05374FF99BDD428F58AA5A18"
    },
    "version": "1.0"
}

正常返回示例

{
    "code": 200,
    "message": "success",
    "data": {
         "userId":"10B6336EFE05374FF99BDD428F58AA5A18",
         "attrList":[
               {
                    "attrKey":"name",
                    "attrValue":"小明"
               }
         ]
    }
}

异常返回示例

{
 "code":503,
 "id":"4fa207ca-fffd-48bb-94b8-e6f7ca6c99c3",
 "localizedMsg":"服务不可用",
 "message":"service not available."
}

错误码

请参考公共错误码

虚拟用户属性定义表