梯控服务API
更新时间：2019-09-23 18:01:25
梯控服务API接口以阿里云IoT统一网关HTTP接口的形式提供，使用方法参考API网关客户端。
访问域名：api.link.aliyun.com，接口协议：HTTPS。
关于API的
生成二维码
| path | 版本 | 是否需要登录 |
|---|---|---|
| 通用二维码接口（复用人行）： /homelink/common/qrcode/generate |
1.0.0 | 否 |
入参
| 字段 | 类型 | 是否必传 | 备注 |
|---|---|---|---|
| identityId | String | 是 | 申请二维码人员的统一身份ID |
出参
| 字段 | 类型 | 备注 |
|---|---|---|
| code | Integer | 返回码 |
| message | String | 返回信息 |
| data | String | 二维码字符串 |
示例
请求示例
{
"identityId":"50acopfd3a94900494085ed2699e052432c34452"
}
返回示例
{
"code": 200,
"id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
"data":"24DD9END8CD3",
"message": null,
"localizedMsg": null
}
梯控二维码权限配置
| path | 版本 | 是否需要登录 |
|---|---|---|
| /elevator/control/perm/qrcode/config | 1.0.0 | 否 |
入参
| 字段 | 类型 | 是否必传 | 备注 |
|---|---|---|---|
| qrCode | String | 是 | 二维码 |
| iotIds | JSONArray | 是 | 待配置权限的梯控设备iotId |
| identityId | String | 是 | 申请二维码人员的统一身份ID |
| perm | Array | 否 | 梯控设备配置楼层权限，如果为空则为所有楼层，最多支持64层楼，每个楼层字符串为数组/字母/-组合，不超过5个字符 |
| effectiveTime | String | 否 | 二维码生效期，时间格式 yyyy-MM-dd HH:mm:ss 默认为当前时间 |
| expiryTime | String | 是 | 二维码有效期，时间格式 yyyy-MM-dd HH:mm:ss |
出参
| 字段 | 类型 | 备注 |
|---|---|---|
| code | Integer | 返回码 |
| message | String | 返回信息 |
示例
请求示例
{
"qrCode": "24DD9END8CD3",
"identityId":"50acopfd3a94900494085ed2699e052432c34452",
"iotIds": [
"p2OsgId2N2kXMWThRCQP000101"
],
"perm": ["-1","2","12"],
"effectiveTime":"2019-03-04 18:00:00",
"expiryTime":"2020-03-04 18:00:00"
}
返回示例
{
"code": 200,
"id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
"message": null,
"localizedMsg": null
}
梯控二维码权限查询
| path | 版本 | 是否需要登录 |
|---|---|---|
| /elevator/control/perm/qrcode/query | 1.0.0 | 否 |
入参
| 字段 | 类型 | 是否必传 | 备注 |
|---|---|---|---|
| qrCode | String | 是 | 二维码 |
| identityId | String | 是 | 申请二维码人员的统一身份ID |
| iotId | String | 是 | 待查询权限的梯控设备iotId |
出参
| 字段 | 类型 | 备注 |
|---|---|---|
| code | Integer | 返回码，200则表示查询成功 |
| message | String | 返回信息 |
| data | JSONObject | 二维码权限信息 |
| perm | Array | 梯控设备楼层权限 |
| effectiveTime | String | 二维码生效期 |
| expiryTime | String | 二维码有效期 |
示例
请求示例
{
"qrCode": "24DD9END8CD3",
"identityId":"50acopfd3a94900494085ed2699e052432c34452",
"iotId": "p2OsgId2N2kXMWThRCQP000101"
}
返回示例
{
"code": 200,
"id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
"data" : {
"perm": ["1", "2", "3"],
"effectiveTime":"2019-03-04 18:00:00",
"expiryTime":"2020-03-04 18:00:00"
}
"message": null,
"localizedMsg": null
}
梯控二维码权限移除
| path | 版本 | 是否需要登录 |
|---|---|---|
| /elevator/control/perm/qrcode/remove | 1.0.0 | 否 |
入参
| 字段 | 类型 | 是否必传 | 备注 |
|---|---|---|---|
| qrCode | String | 是 | 二维码 |
| identityId | String | 是 | 申请二维码人员的统一身份ID |
| iotIds | JSONArray | 是 | 梯控设备iotId |
出参
| 字段 | 类型 | 备注 |
|---|---|---|
| code | Integer | 返回码，成功则返回200 |
| message | String | 返回信息 |
示例
请求示例
{
"qrCode": "24DD9END8CD3",
"iotIds": [
"p2OsgId2N2kXMWThRCQP000101"
],
"identityId":"50acopfd3a94900494085ed2699e052432c34452"
}
返回示例
{
"code": 200,
"id":"4a70179d-47d8-4fdf-9067-8a5eedf63483",
"data" : "xxxxx"
"message": null,
"localizedMsg": null
}