探鸽开放平台API文档
  1. 设备模块
探鸽开放平台API文档
  • 服务器API文档
    • 开放API V2
      • API For Server
        • 账户模块
          • 开发者内部 UserID登录
          • 注销账号
        • 设备模块
          • 查询设备信息
          • 查询设备封面
          • 查询设备在线信息
          • 查询设备在线信息(V3)
          • 查询设备的用户列表
          • 查询用户的设备列表
          • 查询应用的设备类型
          • 查询设备的类型信息
          • 查询SIM卡关联的设备ID列表
          • 解绑设备
        • 事件与云录像
          • 按ID查询云事件 (v3)
          • 查询设备某天的云事件(v3)
          • 上报事件
          • 查询设备某天的云事件
          • 按ID查询云事件
          • 查询设备上传的日志文件
          • 查询设备某天的云录像丢失记录
          • 统计设备云录像的录像文件
        • 消息模块
          • 向设备发送消息
          • 向设备发送指令-订阅消息回调通知
          • 向设备发送指令 - 取消订阅消息通知
          • 向设备发送指令 - 查询已订阅的消息通知
          • 向设备发送预定义指令
          • 通过长连接向APP发送消息
        • 推送模块
          • 向用户APP推送通知
          • 批量向用户APP推送通知
          • 查询用户APP推送信息
          • 批量查询用户APP推送信息
        • SIM卡模块
          • 查询SIM卡信息
          • 查询SIM卡状态
          • 停用SIM卡(异步)
          • 恢复SIM卡(异步)
          • 查询SIM卡日用量
          • 查询套餐内4G卡流量使用情况
        • OTA模块
          • 新增固件版本
          • 查询固件列表
          • 查询固件版本列表
          • 新增设备升级规则
          • 批量删除升级规则中设备
          • 删除固件版本
        • VoIP
          • 查询设备已授权呼叫微信小程序的用户列表
          • 微信呼叫事件通知回调
          • 查询用户已授权呼叫微信小程序的设备列表
        • 增值服务
          • 查询套餐列表
          • 查询套餐详情
          • 查询设备开通的套餐列表
          • 提前生效套餐
          • 套餐升级/降级
          • 转移套餐
          • 更新已开通服务的能力
          • 查询物联网卡开通的套餐
          • 对已开通套餐的生效顺序排序
          • 查询套餐转移历史记录
        • 低功耗设备
          • 唤醒低功耗设备
        • 订单模块
          • 开通套餐
          • 取消套餐
          • 查询订单列表
          • 查询订单
          • 查询订单流水
        • 数据统计
          • 查询设备电量历史记录
          • 查询设备网络信号强度历史记录
          • 查询告警事件统计
          • 查询SD卡上报记录
          • 查询设备上下线历史记录
          • 查询设备唤醒类型以及次数
        • 物模型
          • 查询设备物模型
          • 删除设备物模型属性
          • 更新物模型
        • 自定义数据
          • 查询设备时序数据
          • 查询操作记录
        • 日志上传
          • 开启设备上传日志
          • 停止设备上传日志
          • 查询设备日志配置
          • 查询设备日志文件列表
        • 转移设备模块
          • 向UserID 转移设备
          • 向账号转移设备
          • 向开发者内部UserID 转移设备
        • AI应用
          • 修改设备AI摘要配置
          • 修改设备AI检索配置
          • 修改设备AI应用配置
        • 设备ID管理
        • 配置模块
          • 开发者的应用配置
        • 客户模块
      • API For Client
        • 访问授权
          • 查询登录令牌信息
        • 账户模块
          • 注册账号
          • 绑定已有账号
          • 绑定新账号
          • 查询已绑定的第三方登录账号列表
          • 取消第三方登录
          • 登录账号
          • 修改密码
          • 重置密码
          • 修改昵称
          • 查询账号详情
          • 苹果登录
          • Facebook登录
          • Google登录
          • LINE登录
          • 微信登录
          • 微信小程序登录
          • 注销账号
          • 退出登录
          • 刷新登录令牌
          • 获取一键认证码
        • 配置模块
          • 开发者的自定义配置
          • 查询开发者支持的超级能力集合
          • 开发者的应用配置
        • 设备模块
          • 预添加设备
            POST
          • 添加设备
            POST
          • 查询预添加设备结果
            GET
          • 查询设备列表
            POST
          • 查询设备时区
            POST
          • 设置设备时区
            PATCH
          • 查询设备封面
            POST
          • 修改设备名称
            PATCH
          • 解除绑定
            DELETE
          • 签发设备令牌
            POST
          • 查询设备连接信息
            POST
          • 查询设备在线状态
            POST
          • 查询设备在线状态v3
            POST
          • 查询设备物联网卡号
            POST
          • 查询设备固件升级结果
            GET
          • 查询设备固件版本升级结果
            GET
          • 门锁开锁.预授权
            GET
          • 门锁.设置开锁密码
            POST
          • 查询设备视频密码
            GET
          • 查询设备是否可升级
            POST
          • 发送设备固件升级指令
            POST
        • 事件与云录像
          • 查询设备截图
          • 查询云事件列表
          • 按ID查询云事件
          • 按ID删除云事件
          • 按时间删除云事件
          • 查询设备某天的云事件
          • 查询单台设备N天的云事件
          • 查询设备某天的云录像
          • 查询单台设备N天的云录像
          • 获取设备的OSS访问令牌
        • 推送模块
          • 上报手机推送ID
          • 查询事件推送开关
          • 查询事件标签列表
          • 更新事件推送开关
          • 批量查询事件推送开关
        • 消息模块
          • APP向设备发送消息
          • 获取验证码
          • 校验验证码
          • 向设备发送预定义指令
        • WebRTC代理
          • 获取webRTC服务器的SDP
          • 获取打洞服务器的地址
        • 统计模块
          • 查询设备SD卡信息
          • 查询设备电量
          • 查询设备时间区间内的电量记录
          • 查询设备电量记录
          • 查询设备SD 卡使用记录
          • APP上报播放视频的统计数据
          • APP 上报呼叫状态
        • 分享设备模块
          • 主人.向指定账号分享设备
          • 主人.向指定用户ID分享设备
          • 主人.取消分享
          • 主人.查询分享列表
          • 主人.获取分享码
          • 主人.拒绝共享设备
          • 主人.同意共享设备
          • 查询分享码信息
          • 客人.使用分享码
          • 客人.退出分享
          • 客人.申请共享设备
        • 增值服务-套餐
          • 查询服务商的套餐列表
          • 查询已购买服务
          • 查询指定订单的套餐
          • 提前生效套餐
        • AI识别
          • 图片识别
        • 广告模块
          • 获取广告配置
        • VoIP
          • 查询已授权呼叫微信小程序的设备列表
          • 授权微信小程序呼叫设备
          • 查询设备是否支持呼叫小程序
          • 微信小程序创建房间
          • 微信小程序通话接通前中止
          • 获取设备票据
          • 云呼-设备呼叫小程序
        • SIM卡模块
          • 查询SIM卡信息
        • 物模型
          • 查询设备物模型
          • 更新物模型
          • 删除设备物模型属性
        • AI应用
          • AI事件检索
          • AI检索查询初始化
          • AI检索查询更多
        • 自定义数据
          • 查询设备时序数据
      • 基础服务调度接口
        POST
  • 数据模型
    • Schemas
      • DeviceLogConf
      • 成功
      • SuccessResponse
      • PublishEventRequest
      • DeviceLogFileInfo
      • access_token无效
      • QueryEventsV3Response
      • DeviceLogFileList
      • 禁止访问
      • EventV3
      • DeviceLogOssToken
      • 未找到资源
      • EventTag
      • SuccessResponseData
      • 业务错误描述
      • ErrorResponse
      • 添加设备/修改设备名称的请求体
      • 启用/禁用播放实时的请求体
      • 业务处理出错的返回结果
      • 启用/禁用播放云录像的请求体
      • 获取access_token的返回参数
      • 查询设备列表的请求体
      • 查询设备列表的返回结果
      • 查询设备的返回结果
      • 设备信息
      • 添加设备成功的返回结果
      • 查询设备电量的返回结果
      • 查询SD卡信息的返回结果
      • 向设备发送指令的请求体
      • 查询告警事件列表的返回结果
      • 查询云回放列表的返回结果
      • 查询某天的播放时长的返回结果
      • 查询设备是否允许云回放的返回结果
      • 查询HLS播放信息的返回结果
      • 查询设备是否允许实时播放的返回结果
      • 查询预存费用余额的返回结果
      • 查询总使用空间的返回结果
      • 查询设备某天的空间占用量的返回结果
      • 查询设备云录像服务的返回结果
      • 启用设备云录像服务的请求体
      • 启用设备智能识别服务的请求体
      • 设置设备云录像服务的请求体
      • 查询设备智能识别服务的返回结果
      • 查询设备智能识别调用次数的返回结果
      • 查询智能识别服务支持的物体的返回结果
      • webRTC信息
      • 响应成功
    • Response
      • query-device-bindings-ok
      • ErrorResponse
      • query-device-binding-ok
      • UnauthorizedResponse
      • device-bind-ok
      • query-uuid-cloud-event-ok
      • query-uuid-cloud-video-ok
      • query-uuid-cloud-stats-ok
      • query-uuid-cloud-status-ok
      • access-token-ok
      • query-uuid-stats-battery-ok
      • query-uuid-stats-sdcard-ok
      • query-fund-ok
      • query-uuid-realtime-hls-ok
      • query-uuid-realtime-stats-ok
      • query-uuid-realtime-status-ok
      • query-uuid-storage-service-ok
      • query-storage-stats-ok
      • query-uuid-storage-stats-ok
      • query-uuid-ai-service-ok
      • query-uuid-ai-stats-ok
      • query-ai-objects-ok
      • 200OK
      • 401Unauthorized
      • 403Forbidden
      • 404NotFound
      • 500InternalError
  1. 设备模块

查询设备在线状态

POST
/v2/device/online
长电设备:在线状态及时刷新,离线状态会等待三次心跳包(75秒内)均无效才会置为离线
低功耗设备:在线状态及时刷新,离线状态会等待三次心跳包(300秒内)均无效才会置为离线

请求参数

Header 参数

Body 参数application/json

示例
{
    "device_id": "633U5DMHS8HW"
}

请求示例代码

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
请求示例请求示例
Shell
JavaScript
Java
Swift
curl --location --request POST '/v2/device/online' \
--header 'X-Tg-App-Id: xxx' \
--header 'X-Tg-Platform: {{platform}}' \
--header 'X-Tg-Sdk-Version: 23910000' \
--header 'X-Tg-App-Store: {{appstore}}' \
--header 'X-Tg-App-Version: {{app_version}}' \
--header 'X-Tg-App-Pkgname: {{pkgname}}' \
--header 'X-Tg-Date: {{currentUTCTime}}' \
--header 'Accept-Language: zh-CN' \
--header 'Authorization: ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "device_id": "633U5DMHS8HW"
}'

返回响应

🟢200成功
application/json
Body

示例
{
    "code": 200,
    "data": {
        "1702D8OBYWWQ": {
            "client_addr": "192.61.85.172:46929",
            "dormant_status": {
                "is_alive": true,
                "last_heartbeat_data": "60,0",
                "last_heartbeat_time": 1743246848,
                "last_offline_time": 1743242733,
                "sleep_login_time": 1743242733
            },
            "down_at": 1743242735,
            "is_online": true,
            "live_time": -1,
            "register_status": {
                "down_at": 1743242735,
                "is_online": false,
                "up_at": 1743242704
            },
            "up_at": 1743242733
        }
    },
    "msg": "ok",
    "ok": 1,
    "requestid": "fe023cca-35a5-4c20-95c6-58ae3c4988d7",
    "status": "ok"
}
🟠400错误
🟠401请登录
🟠403禁止访问
🟠404资源不存在
🔴500服务器内部错误
修改于 2026-01-23 02:20:46
上一页
查询设备连接信息
下一页
查询设备在线状态v3
Built with