设备管理列表查询(API名称:getManageDeviceList)
功能介绍
用于与客户系统对接设备管理列表查询。
相关接口
接口名称 | 调用说明 |
|---|---|
调用该接口获取到Token,再调用其他接口时,需要在请求消息头中添加“Authorization”,其值即为Token。 |
URL
请求方式 | HTTPS地址 | 服务架构 | 消息体类型 |
|---|---|---|---|
POST | https://isdp+域名/openapi/v1/ivm/getManageDeviceList | OpenAPI | application/json |
请求头
KEY | VALUE | 是否必填 | 描述 |
|---|---|---|---|
Content-Type | application/json | 是 | 无 |
Authorization | bearer ${access_token} | 是 | bearer +“ ”+5.2.1中获取的access_token的值 |
请求参数
参数 | 类型 | 是否必填 | 描述 |
|---|---|---|---|
page | Object | 否 | 分页参数 |
start | Integer | 否 | 当前页码,分页参数,page子项 |
count | Integer | 否 | 每页条数,分页参数,page子项 |
deviceId | String | 否 | 设备编码 |
projectNumber | String | 否 | 项目编码 |
deviceUserId | Long | 否 | 设备使用Id |
autoJoin | String | 否 | 是否主动接入,可选值Y或者N,Y标识开启,N标识不开启 |
orgId | Long | 否 | 组织Id |
parentDeviceId | String | 否 | 父设备Id |
响应参数
参数 | 类型 | 描述 |
|---|---|---|
isdpDeviceId | String | isdp唯一设备ID |
deviceId | String | 设备ID |
channelId | String | 通道ID |
deviceName | String | 设备名称 |
deviceState | String | 设备状态 |
accessProtocol | String | 接入协议 |
deviceType | String | 设备类型 |
deviceSystemState | String | 设备管理状态 |
description | String | 描述 |
model | String | 设备型号 |
manufacture | String | 生产厂商 |
channelTotal | int | 通道总数 |
streamTotal | int | 每个通道码流数量 |
firmware | String | 摄像头固件版本号 |
deviceAbility | String | 能力集 |
mac | String | mac地址 |
createTime | String | 创建时间 |
updateTime | String | 更新时间 |
protocolVersion | String | 协议版本 |
deviceIp | String | 设备ip |
devicePort | String | 设备端口 |
projectName | String | 项目名称 |
projectNumber | String | 项目编码 |
deviceAddress | String | 设备地址 |
fileId | String | 图片编号 |
sysType | String | 系统类型 |
fileSize | String | 文件大小 |
fileName | String | 文件名称 |
fileExt | String | 文件扩展名 |
deviceAddressNumber | String | 设备地址编号 |
deviceSubType | String | 子设备类型 |
deviceAlarmStatus | String | 设备告警状态 |
autoJoin | String | 是否主动入会 |
battery | String | 电量 |
ownnerId | String | 设备责任人ID |
longitude | String | 经度 |
latitude | String | 纬度 |
chatJid | String | IM群组ID |
chatId | String | IM聊天ID |
liveChannelId | String | 频道播放ID |
userName | String | 设备使用人名称 |
ownnerName | String | 设备责任人名称 |
webPlayUrl | String | web播放地址 |
bindStatus | Integer | 设备绑定状态 |
bindUserId | Long | 设备绑定的用户Id |
buOrgId | Long | 设备所在组织Id |
buOrgName | String | 设备所在组织名称 |
coordType | String | 坐标类型 |
creationDate | Date | 创建时间 |
deviceManageState | String | 设备管理状态 |
deviceStateBefore | String | 设备上报之前的状态 |
deviceTypeName | String | 设备类型名称 |
deviceUserId | Long | 设备使用人Id |
deviceUserName | String | 设备使用人名称 |
deviceUserNameOnly | String | 设备使用人名称 |
enableEndSide | String | 是否开启边缘AI |
enableVideoRecording | String | 是否开启录像 |
groupId | Long | 群组Id |
groupName | String | 群组名称 |
integrationPlatform | String | 集成平台 |
lastReportTime | Date | 最后一次上报时间(时间戳) |
lastUpdateDate | Date | 最后更新时间(时间戳) |
lastUpdatedBy | Long | 最后更新人 |
onlineDuration | Long | 设备在线时长 |
stateChangeReason | String | 设备状态改变原因 |
stateChangeReasonCode | String | 设备状态改变原因码 |
storageRemain | Long | 存储保留 |
storageTotal | Long | 存储总计 |
deviceTypeName | String | 设备类型名称 |
tenantId | Long | 租户Id |
请求示例
{
"deviceId" : "15017380817",
"projectNumber" : "",
"deviceUserId" : "",
"autoJoin" : "",
"orgId" : 0,
"page.start" : 0,
"page.count" : 30,
"parentDeviceId" : null
} 响应示例
{
"status" : 1,
"message" : "SUCCESS",
"error" : null,
"data" : {
"data" : [{
"deviceId" : "15017380817",
"isdpDeviceId" : "15017380817--1",
"channelId" : "-1",
"deviceName" : "张源兆3的手机",
"deviceState" : "ONLINE",
"accessProtocol" : null,
"deviceType" : "MOBILE",
"deviceSystemState" : null,
"description" : null,
"model" : null,
"manufacture" : null,
"channelTotal" : 0,
"streamTotal" : 0,
"firmware" : null,
"deviceAbility" : null,
"mac" : null,
"createTime" : null,
"updateTime" : null,
"protocolVersion" : null,
"deviceIp" : null,
"devicePort" : null,
"tenantId" : 886,
"projectNumber" : null,
"projectName" : "",
"deviceAddress" : null,
"fileId" : null,
"sysType" : null,
"fileSize" : null,
"fileName" : null,
"fileExt" : null,
"deviceAddressNumber" : null,
"webPlayUrl" : null,
"enableVideoRecording" : "Y",
"deviceManageState" : "ACTIVATION",
"deviceSubType" : "其他",
"creationDate" : 1647501832000,
"lastUpdateDate" : 1662459488000,
"lastUpdatedBy" : 299057,
"deviceAlarmStatus" : null,
"autoJoin" : "N",
"battery" : "40",
"ownnerId" : null,
"longitude" : "113.888496",
"latitude" : "22.960361",
"chatJid" : "748544@saasgroupchat.xxxxxxxxxxxx.com",
"liveChannelId" : "267736802078789",
"deviceUserId" : 429030,
"buOrgId" : 830,
"buOrgName" : "杨凌作业系统测试",
"storageTotal" : null,
"storageRemain" : null,
"onlineDuration" : 16738,
"customerOrgName" : null,
"customerOrgCode" : null,
"enableEndSide" : "N",
"networkType" : null,
"systemVersion" : "MI 8_29",
"applicationVersionCode" : "1715",
"applicationVersionName" : "08_APP_MOBILE",
"parentDeviceId" : null,
"integrationPlatform" : null,
"verificationCode" : "******",
"deviceGbPassword" : "******",
"userName" : "张源兆_18617324836",
"ownnerName" : null,
"deviceUserName" : "张源兆3_15017380817",
"deviceUserNameOnly" : "张源兆3",
"deviceTypeName" : "手机"
}
],
"pos" : 0,
"total_count" : 1,
"entityName" : null,
"totalCount" : 1
},
"timestamp" : "2022-09-06T18:21:02.679+0800"
} 状态码
状态码请参见状态码。
错误码
错误码请参见错误码。

