批量绑定设备,一次最多绑定租户下的20个设备。
路径 | /living/cloud/user/binding/device/batch/bind |
版本号 | 1.0.1 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 否 |
超时时间 | 5000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
openId | String | 否 | 4AC1ACC******93093A4 | 三方用户外标id(openId和identityId二者必须有其一)。 |
openIdAppKey | String | 否 | ACC******182F9309 | 开放平台颁发的appKey(如果使用openId,则该参数为必需)。 |
identityId | String | 否 | 9beb22c5******dd8bb018b3a | 用户身份id(openId和identityId二者必须有其一)。 |
deviceList | List | 是 | 设备列表,一次最多绑定20个。 | |
productKey | String | 否 | a1Zg******ROL | 设备productKey,productKey / deviceName 和 iotId必须有一个,如两个都有,会使用iotId。 |
deviceName | String | 否 | bFujt******PQxld | 设备productKey,productKey / deviceName 和 iotId必须有一个,如两个都有,会使用iotId。 |
iotId | String | 否 | bFujtvxd******xld000000 | 设备productKey,productKey / deviceName 和 iotId必须有一个,如两个都有,会使用iotId。 |
projectId | String | 是 | a1Zg******ROL | 项目id。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int |
响应码,200:成功。 |
|
message | String |
错误消息。 |
|
localizedMsg | String |
本地语言错误消息。 |
|
data | JSON |
响应结果。 |
|
iotId | String |
设备的iotId。 |
|
productKey | String |
设备的productKey。 |
|
deviceName | String |
设备的deviceName。 |
|
bindCode | Int |
绑定结果:0:代表产品是授权式,且用户绑定为管理员。绑定成功; 1:代表产品是授权式,已经有管理员绑定了,还去绑定,绑定失败; 2:代表产品是分享式,该用户为成员,绑定成功; 3:代表产品是分享式,该用户为管理员,绑定成功; 4:代表产品是抢占式,该用户绑定成功,没有人被解绑; 5:代表产品是抢占式,该用户绑定成功,且有人被解绑; 6:设备对应的产品没有配置分享模式; 7:设备无效,设备没有产品信息等; 8:对设备没有权限 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.1"
},
"params":{
"openId": "4AC1ACC******93093A4",
"openIdAppKey": "ACC******182F9309",
"identityId": "9beb22c5******dd8bb018b3a",
"deviceList": "value3",
"projectId": "a1Zg******ROL"
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": [
{
"productKey": "xxxx",
"deviceName": "xxxx",
"iotId": "xxxx",
"bindCode": 7
}
]
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}