设备上报

接口说明

向 DTS 平台注册实体，支持单实体/多实体批量上报；接口接收实体基础信息及自定义属性参数，并返回上报结果。

接口

项目 具体说明
请求方式 POST
接口路径 /bv-universal-gateway/api/accessGateway/deviceReport
访问地址 http://{IP地址}:{端口} 或 http://{域名}:{端口}（以实际部署为准）
Content-Type application/json （必填）
字符编码 UTF-8

请求体

整体格式

请求体为 JSON 数组 ，数组元素为单个设备的上报信息对象，支持批量上报多个设备。

请求参数

字段名称 字段类型 是否必传 默认值 说明
productId string 是 - 产品唯一标识符，由平台分配，不可为空
deviceId string 是 - 设备在对应产品下的唯一标识符，不可为空
deviceName string 是 - 设备名称，支持自定义，不可为空
deviceStatus number 否 1 设备状态：0 = 未启用，1 = 已启用
deviceType number 否 0 设备类型：0 = 动态资源，1 = 静态资源
location string 否 “0 0 0” 设备位置纬经度，格式为 纬度 经度 海拔（空格分隔，单位：度/米）
timestamp number 否 当前时间戳 上行数据传输时间，GMT 1970-01-01 00:00:00 至今的毫秒数
version string 否 “default” 版本号，支持自定义，例如 “v1.0.0”
payload object 否 {} 上报的自定义参数：
- 事件上报：填充事件输出参数
- 属性上报：填充设备属性参数

请求示例

curl --location --request POST 'http://Host/bv-universal-gateway/api/accessGateway/deviceReport' \
--header 'User-Agent: Apifox/1.0.0 (https://apifox.com)' \
--header 'Content-Type: application/json' \
--header 'Accept: */*' \
--header 'Connection: keep-alive' \
--data-raw '[
    {
        "productId": "ovw9GOl46TSqbedc",
        "deviceId": "d0ca3710-1575-4977-88a6-ee852082948b",
        "deviceName": "设备1739255549",
        "deviceStatus": 0,
        "payload": {
            "ipAddress": "164.27.227.218",
            "switchStatus": true,
            "brandInformation": "划见五选",
            "scheduledOnTime": "14:00:00",
            "scheduledOffTime": "14:32:29",
            "humidity": "0.13°",
            "temperature": "0.82°",
            "networkType": "IPv4",
            "connectionStatus": "已连接",
            "productModel": "面影好织世",
            "currentAndVoltage": {
                "realTimeVoltage": 220,
                "realTimeCurrent": 0.89
            },
            "powerRelated": {}
        }
    }
]'

响应说明

响应体格式

字段名称 字段类型 说明
code number 响应状态码：0 = 成功，非 0 = 失败
message string 响应描述：成功返回 “success”，失败返回具体错误信息
info object 扩展信息：成功时为 null，失败时可能返回参数错误明细等具体内容

响应状态码

code message 排查建议
0 success -
10000 未知错误
10001 参数错误 校验参数类型与格式（如 timestamp 需为毫秒级数字、location 格式是否合规）
10024 缺少必传参数或参数内容为空 检查 productId、deviceId、deviceName 是否为空或未传递
20018 上报数据，获取产品Profile失败，请稍后重试 确认 productId 正确性，检查产品是否已在平台完成创建,是否有发布
20020 上报数据失败，获取产品Profile属性列表为空 确认目标产品已配置产品Profile
20022 实体上报失败，实体数据列表为空 检查请求体是否为非空 JSON 数组，禁止传递空数组或非数组格式
20023 上报数据失败，获取产品数据解析脚本为空 确认是否配置产品的数据解析脚本

响应示例

成功响应

{
    "code": 0,
    "message": "success",
    "info": null
}

失败响应

{
    "code": 20018,
    "message": "上报数据失败，未找到产品Profile，请检查网关后重试",
    "info": null
}
作者：北京-产品-yantings  创建时间：2024-08-23 11:46
最后编辑：北京-产品-yantings  更新时间：2026-07-07 18:14
上一篇：
下一篇：