Skip to content

获取名下锁列表 ​

https://cnapi.ttlock.com/v3/lock/list

通过该接口获取用户在通通锁APP里添加的锁,或是对接APP SDK通过云端初始化锁接口初始化的锁。

  • 通通锁APP添加的锁,请用添加锁时的通通锁APP的账号和密码获取访问令牌后调用该接口。

  • 云端初始化锁接口初始化的锁,请使用初始化锁时相同用户的访问令牌。

注意!该接口只返回最高管理员的锁(即锁是该账户添加),授权的锁不会在返回列表中;对于普通用户和授权管理员,请通过获取名下钥匙列表接口获取。

如果对接通通酒店,该接口也可以获取取电开关或者梯控列表,只需新增参数type,type = 1 为锁列表,type = 2 为梯控列表, type = 3 为取电开关列表。

1 HTTP请求方法及示例 ​

POST, ContentType:application/x-www-form-urlencoded

javascript
curl --location -g --request GET 'https://cnapi.ttlock.com/v3/lock/list?clientId=fd2ff35ee3d8424c8665c07b7b9a7f45&accessToken=780f7671b6e6be3010d9787f19207aca&pageNo=1&pageSize=20&date=1625025703000&groupId=1719'

2 参数说明 ​

名称类型是否必需描述
clientIdStringY创建应用分配的client_id
accessTokenStringY访问令牌,通过获取访问令牌接口获取
lockAliasStringN锁别名模糊匹配
groupIdIntN分组ID,获取某个分组下的锁,来源于添加分组接口
pageNoIntY页码,从1开始
pageSizeIntY每页数量,最大1000
dateLongY当前时间(时间戳,单位毫秒)

3 返回参数及示例 ​

参数类型描述
listJSONArray记录列表
pageNoInt页码,从1开始
pageSizeInt每页数量,最大1000
pagesInt总页数
totalInt总条数

列表中的对象

参数类型描述
lockIdInt锁ID,由锁初始化接口生成
lockNameString锁的蓝牙名称
lockAliasString锁别名
lockMacString锁mac地址
electricQuantityInt锁电量
featureValueString锁特征值,用于表示锁支持的功能
hasGatewayInt是否有连接网关,1-是、0-否
lockDataString锁数据,用于操作锁
groupIdInt分组ID
groupNameString分组名称
dateLong锁初始化时间
{
    "list": [
        {
            "lockId": 532323,
            "lockName":"YS1003_c18c9c",
            "lockAlias":"大门锁",
            "lockMac": "C5:40:E0:9C:8C:C1",
            "electricQuantity": 55,
            "featureValue":"3F0421C4F5F3",
            "hasGateway": 1,
            "lockData": "xxxxxxxxxxxxx",
            "groupId": 456,
            "groupName": "4栋2楼",
            "date": 1528878944000}
    ],
    "pageNo":1,
    "pageSize":20,
    "pages":1,
    "total":1
}