用户服务
更新时间:2018-03-23 13:54:11
生成设备分享用的二维码
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/uc/genShareQrCode |
1.0.0 |
生成设备分享用的二维码 |
是 |
请求参数
参数 |
类型 |
必填 |
描述 |
iotId |
String |
是 |
设备iotId |
返回参数
参数 |
类型 |
描述 |
qrKey |
String |
生成的二维码key |
示例
请求示例
{
"request": {
"iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
"apiVer": "1.0.0"
},
"id": 1508212818676,
"params": {
"iotId":"xxxx"
},
"version": "1.0"
}
正常返回示例
{
"code": 200,
"data": {
"qrKey": "xxxxxx"
},
"id": "6ec222eb-87fc-421e-9b67-351df196ceb3"
}
错误码
错误码 |
错误信息 |
详细描述 |
2073 |
this product not support share |
该设备的分享模式不支持生成二维码 |
2065 |
identityId and iotId not bound |
设备和账号未绑定 |
2066 |
identityId is not manager |
该用户不是设备的管理员 |
绑定push通道
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/uc/bindPushChannel |
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"
}
错误码
扫描二维码绑定设备
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/uc/scanShareQrCode |
1.0.0 |
扫描二维码绑定设备 |
是 |
请求参数
参数 |
类型 |
必填 |
描述 |
qrKey |
String |
是 |
扫描的二维码key |
返回参数
参数 |
类型 |
描述 |
iotId |
String |
设备的iotId |
productKey |
String |
设备的productKey |
deviceName |
String |
设备的deviceName |
productName |
String |
设备的产品名称 |
productImage |
String |
设备的产品图片 |
productModel |
String |
设备的产品型号 |
netType |
String |
设备入网类型 |
thingType |
String |
设备的类型:"VIRTUAL", "WEB", "APP","DEVICE" |
nodeType |
String |
设备的节点类型:"DEVICE", "GATEWAY" |
status |
Byte |
设备的状态 |
示例
请求示例
{
"request": {
"iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
"apiVer": "1.0.0"
},
"id": 1508212818676,
"params": {
"qrKey":"xxxx"
},
"version": "1.0"
}
正常返回示例
{
"code": 200,
"data": {
"productModel": "edge_product",
"iotId": "1We4bf3OAxO2ItLzTHoj00108ec101",
"netType": "NET_ZIGBEE",
"thingType": "DEVICE",
"nodeType": "DEVICE",
"productKey": "a1x74WVJOjK",
"deviceName": "cdf2_0109_302",
"productName": "test444",
"status": 0
},
"id": "7bcff691-4f03-412a-85c5-a242d36d132f"
}
错误码
错误码 |
错误信息 |
详细描述 |
2073 |
this product not support share |
该设备的模式不支持分享 |
获取用户绑定的设备列表
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/uc/listByAccount |
1.0.1 |
获取用户绑定的设备列表 |
是 |
请求参数
参数 |
类型 |
必填 |
描述 |
offset |
Int |
否 |
分页偏移量。默认:0 |
limit |
Int |
否 |
每页取数。默认:100 |
thingType |
String |
否 |
设备类型:"VIRTUAL", "WEB", "APP","DEVICE" |
nodeType |
String |
否 |
设备的节点类型:"DEVICE", "GATEWAY" |
返回参数
参数 |
类型 |
描述 |
identityId |
String |
用户的身份ID |
iotId |
String |
设备的iotId |
productKey |
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 |
设备的状态 |
示例
请求示例
{
"request": {
"iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
"apiVer": "1.0.0"
},
"id": 1508212818676,
"params": {
"offset":0,
"limit":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"
}
错误码
解绑设备
定义描述
path |
版本 |
描述 |
是否需要登陆 |
/uc/unbindAccountAndDev |
1.0.0 |
解绑当前用户和指定设备 |
是 |
请求参数
参数 |
类型 |
必填 |
描述 |
iotId |
String |
是 |
iot设备id |
返回参数
示例
请求示例
{
"request": {
"iotToken": "109049c80bcde4c06b15f6f62e29a3ba",
"apiVer": "1.0.0"
},
"id": 1508212818676,
"params": {
"iotId":"xxxx"
},
"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"
}
错误码