接口列表

本节包含楼宇可视对讲透传相关接口，这些接口只支持楼宇相关设备。

接口列表如下:

序号 接口功能 描述
1 获取通话状态 获取通话状态
2 远程开锁 远程开锁
3 通话操作 通话操作
4 获取主叫信息 获取主叫信息
5 获取门口机列表 获取门口机列表
6 配置麦克风扬声器参数 配置麦克风扬声器参数
7 获取麦克风扬声器参数 获取麦克风扬声器参数
8 配置移动侦测开关和灵敏度 配置移动侦测开关和灵敏度
9 获取移动侦测开关状态和灵敏度 获取移动侦测开关状态和灵敏度
10 获取TF卡状态、总容量、剩余容量 获取TF卡状态、总容量、剩余容量
11 TF卡格式化 TF卡格式化
12 APP登录设备处理 APP登录设备处理
13 获取智能锁列表 获取智能锁列表
14 智能锁开锁 智能锁开锁

获取通话状态

  • 接口功能

    该接口用于获取楼宇可视对讲设备通话状态。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/call/status

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号，字母需为大写 Y
  • HTTP请求报文
POST /api/lapp/building/device/call/status HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "data": {
        "deviceSerial": "427734203",
        "callStatus": 1,
        "verFlag": 1,
        "callerInfo": {
            "buildingNo": 2,
            "floorNo": 23,
            "zoneNo": 2,
            "unitNo": 2,
            "devNo": 1,
            "devType": 1
        }
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
key 类型 备注
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写
callStatus int 获取通话状态，1-无呼叫、2-响铃、3-正在通话
verFlag String 1，代表非V1.4.0版本，后续版本再定
callerInfo Object
buildingNo long 楼号
zoneNo string 期号
unitNo int 单元号
devNo String 设备编号
devType int 设备类型，1-门口机，2-管理机，3-室内机，4-围墙机，5-别墅门口机，6-二次确认机，7-8700客户端，8-4200客户端，9-APP，10-可视门铃,11-VOIP客户端，12-监控点（IPC/NVR/DVR）设备
  • 返回码
返回码 返回消息 描述
200 操作成功 请求成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 获取数据错误或没有呼叫
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

远程开锁

  • 接口功能

    该接口用于楼宇可视对讲设备远程开锁。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/unlock

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 设备序列号,存在英文字母的设备序列号，字母需为大写 Y
type int 开锁类型，1-监视开锁；2-通话开锁 Y
channel int 监视通道，1-主门口机，2-1号从门口机，3-2号从门口机，不能为1-9之外的数字 Y
lockId int 锁ID，0本地锁，1外接锁 N
  • HTTP请求报文
POST /api/lapp/building/device/unlock HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203&type=1&channel=1
  • 返回数据
{
    "code": "200",
    "msg": "操作成功"
}
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 请求参数不合法
20501 开锁失败
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

通话操作

  • 接口功能

    该接口用于楼宇可视对讲设备通话操作。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/call

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
type int 操作类型：2-接听，3-拒接， 4-响铃超时，5-挂断，6-被叫正在通话中 Y
  • HTTP请求报文
POST /api/lapp/building/device/call HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203&type=1
  • 返回数据
{
    "code": "200",
    "msg": "操作成功"
}
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 请求参数不合法
20502 室内机未收到呼叫 type为3时返回该错误码APP应做成功处理，type为4时APP提示响铃超时，type为5时APP提示挂断成功
20503 正在响铃 type为5时APP提示挂断失败
20504 室内机正在通话
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

获取主叫信息

  • 接口功能

    该接口用于获取楼宇可视对讲设备主叫信息。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/dialing/get

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
  • HTTP请求报文
POST /api/lapp/building/device/dialing/get HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "data": {
        "deviceSerial": "427734203",
        "buildingNo": 2,
        "floorNo": 23,
        "zoneNo": 2,
        "unitNo": 2,
        "devNo": 1,
        "devType": 1,
        "lockNum":1,
        "voipNo":null
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
key 类型 备注
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写
buildingNo long 楼号
floorNo string 层号
zoneNo string 期号
unitNo int 单元号
devNo String 设备编号
devType int 设备类型，1-门口机，2-管理机，3-室内机，4-围墙机，5-别墅门口机，6-二次确认机，7-8700客户端，8-4200客户端，9-APP，10-可视门铃,11-VOIP客户端，12-监控点（IPC/NVR/DVR）设备
lockNum int 锁数量。0-无锁，1-只有本地锁，2-本地锁和外接锁
voipNo String VOIP客户端的号码，只有当devType是11时才有效
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 没有呼叫、获取数据错误
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

获取门口机列表

  • 接口功能

    该接口用于获取楼宇可视对讲设备门口机列表。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/list

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
  • HTTP请求报文
POST /api/lapp/building/device/list HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "msgSeq": "c543d24d81914071a7f74769d9c5e2a1",
    "data": {
        "deviceSerial": "836298938",
        "devNum": 2,
        "dev": [
            {
                "devId": 1,
                "devName": "主:1期1幢1单元",
                "devType": 1,
                "lockNum": 1
            },
            {
                "devId": 2,
                "devName": "主二次确认机",
                "devType": 1,
                "lockNum": 0
            }
        ]
    },
    "code": "200",
    "msg": "操作成功!"
}
  • 返回字段
key 类型 备注
deviceSerial String 萤石云设备序列号
devNum int 下挂设备数，最多8个
dev List<Object>
devId int 设备号
devName string 设备名称
devType String 设备类型
lockNum int 锁数量:0-无锁，1-只有本地锁，2-本地锁和外接锁
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 获取从门口机数据错误
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

配置麦克风扬声器参数

  • 接口功能

    该接口用于配置楼宇可视对讲设备麦克风扬声器参数。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/audio/config

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
type int 0-配置扬声器音量；1-配置麦克风音量 Y
value int 0-10之间的数字，代表配置扬声器或麦克风的音量大小 Y
  • HTTP请求报文
POST /api/lapp/building/device/audio/config HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203&type=1&value=3
  • 返回数据
{
    "code": "200",
    "msg": "操作成功"
}
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 参数不合法
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

获取麦克风扬声器参数

  • 接口功能

    该接口用于获取楼宇可视对讲设备麦克风扬声器参数。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/audio/config/get

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
  • HTTP请求报文
POST /api/lapp/building/device/audio/config/get HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "data": {
        "deviceSerial": "427734203",
        "auOut": 3,
        "auIn": 3
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
Key 类型 备注
deviceSerial String 萤石云设备序列号
auOut int 0-10之间的数字，表示扬声器音量大小
auIn int 0-10之间的数字，表示麦克风音量大小
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 参数不合法
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

配置移动侦测开关和灵敏度

  • 接口功能

    该接口用于配置楼宇可视对讲设备移动侦测开光和灵敏度。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/defence/config

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
enable int 移动侦测开关，0表示关，1表示开 Y
sensitivity int 1-6之间的整数，表示移动侦测灵敏度 Y
  • HTTP请求报文
POST /api/lapp/building/device/defence/config HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203&enable=1&sensitivity=3
  • 返回数据
{
    "code": "200",
    "msg": "操作成功"
}
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 参数不合法
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

获取移动侦测开关状态和灵敏度

  • 接口功能

    该接口用于获取楼宇可视对讲设备移动侦测开关状态和灵敏度。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/defence/config/get

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
  • HTTP请求报文
POST /api/lapp/building/device/defence/config/get HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "data": {
        "deviceSerial": "427734203",
        "enable": 1,
        "sensitivity": 3
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
Key 类型 备注
deviceSerial String 萤石云设备序列号
enable int 0关，1开，移动侦测开关状态
sensitivity int 灵敏度，取值1-6
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 参数不合法
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

获取TF卡状态、总容量、剩余容量

  • 接口功能

    该接口用于获取楼宇可视对讲设备TF卡状态、总容量、剩余容量。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/storage/status

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
  • HTTP请求报文
POST /api/lapp/building/device/storage/status HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "data": {
        "deviceSerial": "427734203",
        "status": 1,
        "total": 3,
        "free": 3
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
Key 类型 备注
deviceSerial String 萤石云设备序列号
status int TF卡的状态，0表示正常，1表示异常，2表示未插卡，3表示正在格式化
total int TF卡总容量，最大支持128G
free int TF卡剩余容量，0-最大容量
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 参数不合法
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

TF卡格式化

  • 接口功能

    该接口用于楼宇可视对讲设备TF卡格式化。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/storage/format

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
  • HTTP请求报文
POST /api/lapp/building/device/storage/format HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "code": "200",
    "msg": "操作成功"
}
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 参数不合法
20505 设备操作失败 设备返回其他错误码或者设备响应格式问题
49999 操作异常 接口调用异常

APP登录设备处理

  • 接口功能

    该接口用于APP登录楼宇可视对讲设备获取设备数据。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/info/login

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
  • HTTP请求报文
POST /api/lapp/building/device/info/login HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "data": {
        "bySupport1": 0,
        "bySupport2": 0,
        "bySupport3": 0,
        "multiStream": 1,
        "startDchan": 0,
        "startDtalkchan": 0,
        "chanNum": 0,
        "diskNum": 0,
        "IPchanNum": 0,
        "charEncodeType": 0
    },
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
Key 类型 备注
bySupport1 int 能力1
bySupport2 int 能力2
bySupport3 int 能力3
multiStream int 是否支持多码流，按位表示
startDchan int 起始数字通道号
startDtalkchan int 起始数字对讲通道号
chanNum int 设备通道个数
diskNum int 设备硬盘个数
IPchanNum int 数字通道数
charEncodeType int 设备使用字符类型
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 参数不合法
20505 设备操作失败 设备返回其他错误码
49999 操作异常 接口调用异常

获取智能锁列表

  • 接口功能

    该接口用于获取楼宇可视对讲设备智能锁列表。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/smartlock/list

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
  • HTTP请求报文 
POST /api/lapp/building/device/smartlock/list HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203
  • 返回数据
{
    "data": [
        {
            "lockId": 111,
            "devName": "smart-1"
        },
        {
            "lockId": 222,
            "devName": "smart-2"
        }
    ],
    "code": "200",
    "msg": "操作成功"
}
  • 返回字段
Key 类型 备注
lockId int 锁ID
devName String 锁名称
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 参数不合法
20505 设备操作失败 设备返回其他错误码
49999 操作异常 接口调用异常

智能锁开锁

  • 接口功能

    该接口用于楼宇可视对讲设备智能锁开锁。

  • 请求地址

    https://open.ys7.com/api/lapp/building/device/smartlock/unlock

  • 请求方式

    POST

  • 子账户token请求所需最小权限

    无

  • 请求参数

参数名 类型 描述 是否必选
accessToken String 授权过程获取的access_token Y
deviceSerial String 萤石云设备序列号,存在英文字母的设备序列号，字母需为大写 Y
lockId int 锁ID Y
password String 锁密码 Y
  • HTTP请求报文 
POST /api/lapp/building/device/smartlock/unlock HTTP/1.1
Host: open.ys7.com
Content-Type: application/x-www-form-urlencoded

accessToken=at.dunwhxt2azk02hcn7phqygsybbw0wv6p&deviceSerial=427734203&lockId=111&password=12345678
  • 返回数据
{
    "code": "200",
    "msg": "操作成功"
}
  • 返回码
返回码 返回消息 描述
200 操作成功
10001 参数错误 参数为空或格式不正确
10002 accessToken过期或异常
10004 用户不存在
10005 appKey异常
10011 未开通萤石服务 设备对应用户未注册至应用下
20002 设备不存在 设备序列号输入有误或者设备未被添加或者通道异常
20007 设备不在线
20008 设备响应超时
20014 deviceSerial不合法
20018 该用户不拥有该设备
20500 参数不合法
20505 设备操作失败 设备返回其他错误码
20506 非法命令
20507 智能锁密码错误
20508 开关锁失败
20509 开关锁超时
20510 智能锁设备繁忙
20511 远程开锁功能未打开
49999 操作异常 接口调用异常

results matching ""

    No results matching ""