IotHub
  1. command
IotHub
  • README
  • token
    • createToken
      POST
    • destroyToken
      POST
  • customer
    • customerPage
      POST
    • customerTree
      POST
  • device
    • command
      • commandSend
        POST
      • commandInfoList
        POST
      • cutOilElectric
        POST
      • getConfig
        POST
    • devicePage
      POST
    • deviceTypes
      POST
    • deviceTypeInfo
      POST
    • deviceDataByDeviceIds
      POST
    • deviceDataByCustomerId
      POST
    • deviceTripInfoByTripId
      POST
    • deviceTripsByDeviceId
      POST
    • deviceTraffic
      POST
    • deviceSensorData
      POST
    • expandInfoByDeviceId
      POST
    • saveDeviceChannelName
      POST
  • fence
    • fencePage
      POST
    • fenceInfo
      POST
    • addFence
      POST
    • saveFence
      POST
    • delFence
      POST
    • fenceDevices
      POST
    • fenceDeviceUpdate
      POST
    • fenceDeviceDel
      POST
    • fenceDeviceAdd
      POST
  • push&Webhook
    • README
  • video
    • history
      • README
      • playBackList
      • historicalUpload
      • playBack
      • replaySet
      • taskPage
      • taskStop
      • taskDelete
    • live
      • README
      • H5 Page-V2[Recommend]
      • H5 page
      • liveVideo
      • liveVideoControl
    • getNodes
  • alarm
    • Alert Types
    • alarmTypeList
    • alarmFilePage
    • alarmFileByAlarmId
    • alarmHistoryPage
    • alarmPageByUser
  • audio
    • README
    • talk「Deprecated」
    • talkPlus
  • gallery
    • filePageV2
    • filePage
    • deleteFile
    • capture
    • capturePage
    • captureRecord
  • fleet
    • faceRecordPage
    • rfidPage
  • gps
    • historyData
  • Protocol Analysis
    POST
  • Schemas
    • Schemas
      • BasicDetailVO
      • NetworkVO
      • VideoVO
      • AdvancedDriverAssistanceSystemVO
      • DriverStatusMonitoringSystemVO
      • BlindSpotMonitoringSystemVO
      • ApiDeviceGetConfigVO
      • ApiDeviceGetConfigCommand
      • CommonResult«ApiDeviceGetConfigVO»
    • CommonResult«String»
    • ApiCustomerVO
    • ApiDeviceInfoVO
    • ApiFenceInfoVO
    • DeviceBatteryLevelVO
    • VideoHistoryFileVO
    • ApiAlarmFileVO
    • LicenseSumDTO
    • ApiCaptureFileVO
    • FaceRecordInfoVO
    • ApiGpsDataVO
    • ApiTrafficReportVO
    • CommonResult«PageResult«ApiFleetRfidInfoVO»»
    • ApiCreateTokenCommand
    • PageResult«ApiCustomerVO»
    • PageResult«ApiDeviceInfoVO»
    • ApiPageResult«ApiFenceInfoVO»
    • PageResult«DeviceBatteryLevelVO»
    • ApiVideoLiveCommand
    • PageResult«VideoHistoryFileVO»
    • PageResult«ApiAlarmFileVO»
    • PageResult«LicenseSumDTO»
    • AudioTalkCommand
    • ApiDeviceCommandSendCommand
    • PageResult«ApiCaptureFileVO»
    • PageResult«FaceRecordInfoVO»
    • CommonResult«List«ApiAlarmFileVO»»
    • PageResult«ApiGpsDataVO»
    • PageResult«ApiTrafficReportVO»
    • ApiFleetRfidPageQuery
    • CommonResult«PageResult«ApiCustomerVO»»
    • CommonResult«PageResult«ApiDeviceInfoVO»»
    • CommonResult«ApiPageResult«ApiFenceInfoVO»»
    • ApiPushCommand
    • CommonResult«PageResult«DeviceBatteryLevelVO»»
    • VideoHistoryVO
    • CommonResult«PageResult«VideoHistoryFileVO»»
    • CommonResult«PageResult«ApiAlarmFileVO»»
    • CommonResult«PageResult«LicenseSumDTO»»
    • ApiDeviceCommandVO
    • ApiVideoHistoryVO
    • ApiTalkVO
    • CommonResult«PageResult«ApiCaptureFileVO»»
    • CommonResult«PageResult«FaceRecordInfoVO»»
    • ApiAlarmFileListQuery
    • CommonResult«PageResult«ApiGpsDataVO»»
    • ApiVideoUploadStopCommand
    • CommonResult«PageResult«ApiTrafficReportVO»»
    • PageResult«ApiFleetRfidInfoVO»
    • CommonResult
    • ApiCustomerPageQuery
    • ApiDevicePageQuery
    • ApiFencePageQuery
    • DeviceBatteryLevelPageQuery
    • CommonResult«List«VideoHistoryVO»»
    • VideoHistoryPageQuery
    • ApiAlarmPageQuery
    • LicenseSumPageQuery
    • CommonResult«List«ApiDeviceCommandVO»»
    • CommonResult«List«ApiVideoHistoryVO»»
    • CommonResult«ApiTalkVO»
    • ApiCaptureFilePageQuery
    • ApiFleetFacePageQuery
    • APIGpsPageQuery
    • ApiCaptureFilePageV2Query
    • ApiVideoLiveControlCommand
    • ApiTrafficReportPageQuery
    • ApiFleetRfidInfoVO
    • ApiDestroyTokenCommand
    • CommonResult«List«ApiCustomerVO»»
    • CommonResult«List«String»»
    • CommonResult«ApiFenceInfoVO»
    • DeviceDataVO
    • ApiVideoHistoryQuery
    • LicenseInfoVO
    • ApiAlarmTypeVO
    • ApiDeviceCommandRecentlyQuery
    • AudioTalkV3Command
    • ApiAudioTalkCommand
    • CommonResult«Boolean»
    • ApiCustomerTreeQuery
    • ApiDeviceTypeQuery
    • ApiFenceInfoQuery
    • CommonResult«List«DeviceDataVO»»
    • ApiVideoHistoryReplayCommand
    • PageResult«LicenseInfoVO»
    • CommonResult«List«ApiAlarmTypeVO»»
    • ApiDeviceCutOilElectricCommand
    • ApiCaptureDeleteCommand
    • ApiTaskResult«String»
    • ApiDeviceTypeVO
    • DeviceGpsTripByTripIdQuery
    • VideoUploadCommand
    • CommonResult«PageResult«LicenseInfoVO»»
    • ApiAlarmTypeListQuery
    • CommonResult«ApiDeviceTypeVO»
    • ApiFenceInfoAddCommand
    • LicenseInfoPageQuery
    • ApiVideoUploadCommand
    • ApiReportAlarmVO
    • ApiDeviceTypeInfoQuery
    • DeviceGpsTripVO
    • ApiVideoHistoryReplaySetCommand
    • VideoLiveCommand
    • PageResult«ReportAlarmVO»
    • PageResult«ApiReportAlarmVO»
    • ApiDeviceCaptureCommand
    • ApiCustomerNodeSetDefaultCommand
    • ApiDeviceDataVO
    • CommonResult«DeviceGpsTripVO»
    • VideoHistoryReplayCommand
    • CommonResult«PageResult«ReportAlarmVO»»
    • CommonResult«PageResult«ApiReportAlarmVO»»
    • ApiCaptureInfoVO
    • ApiDeviceExpandVO
    • ApiFenceInfoSaveCommand
    • DevciceGpsTripQuery
    • VideoHistoryReplaySetCommand
    • LicenseStatusCommand
    • ApiVideoHistoryFileVO
    • ApiAlarmDevicePageQuery
    • PageResult«ApiCaptureInfoVO»
    • ApiDeviceShadowVO
    • ApiFenceInfoDelCommand
    • LabelInfoVO
    • LicenseBindCommand
    • PageResult«ApiVideoHistoryFileVO»
    • ApiReportAlarmByUserVO
    • CommonResult«PageResult«ApiCaptureInfoVO»»
    • CommonResult«List«ApiDeviceShadowVO»»
    • ApiFenceDeviceVO
    • DeviceInfoVO
    • LicenseBindCancelCommand
    • CommonResult«PageResult«ApiVideoHistoryFileVO»»
    • PageResult«ApiReportAlarmByUserVO»
    • ApiCaptureInfoPageQuery
    • ApiDeviceShadowQuery
    • CommonResult«List«ApiFenceDeviceVO»»
    • PageResult«DeviceInfoVO»
    • VideoHistoryQuery
    • LicenseMoveCommand
    • ApiVideoHistoryPageQuery
    • CommonResult«PageResult«ApiReportAlarmByUserVO»»
    • ApiDeviceShadowCustomerQuery
    • ApiFenceDeviceQuery
    • CommonResult«PageResult«DeviceInfoVO»»
    • LicenseMoveBackCommand
    • ApiVideoHistoryDeleteCommand
    • ApiAlarmPageByUserQuery
    • CommonResult«List«ApiCaptureFileVO»»
    • CommonResult«List«ApiDeviceDataVO»»
    • ApiFenceDeviceUpdateCommand
    • DevicePageQuery
    • LicenseMoveHistoryVO
    • ApiDeviceTripDataVO
    • ApiNodesVO
    • ApiCaptureRecordCommand
    • ApiDeviceGpsTripByTripIdQuery
    • ApiFenceDeviceDelCommand
    • DeviceExpandVO
    • PageResult«LicenseMoveHistoryVO»
    • CommonResult«List«ApiDeviceTripDataVO»»
    • ApiVideoNodesVO
    • DeviceTripVO
    • ApiFenceDeviceAddCommand
    • DeviceShadowVO
    • ApiDeviceTripVO
    • CommonResult«PageResult«LicenseMoveHistoryVO»»
    • CommonResult«ApiVideoNodesVO»
    • ApiAlarmInfoVO
    • ApiDeviceGpsTripVO
    • CommonResult«DeviceShadowVO»
    • LicenseMoveHistoryPageQuery
    • VideoLiveVO
    • PageResult«ApiAlarmInfoVO»
    • ApiDeviceSensorDataVO
    • CommonResult«ApiDeviceGpsTripVO»
    • DeviceShareShadowQuery
    • LicenseTimeVO
    • CommonResult«VideoLiveVO»
    • CommonResult«PageResult«ApiAlarmInfoVO»»
    • CommonResult«List«ApiDeviceSensorDataVO»»
    • ApiDevciceGpsTripQuery
    • ApiDeviceGpsTripQuery
    • DeviceTypeSimpleVO
    • PageResult«LicenseTimeVO»
    • VideoLiveV3Command
    • ApiAlarmInfoPageQuery
    • ApiDeviceSensorQuery
    • DeviceShareCommand
    • CommonResult«List«DeviceTypeSimpleVO»»
    • CommonResult«PageResult«LicenseTimeVO»»
    • ReportAlarmVO
    • LicenseHistoryPageQuery
    • ApiDeviceExpandConfigVO
    • CommonResult«ReportAlarmVO»
    • LicensePieVO
    • CommonResult«ApiDeviceExpandConfigVO»
    • DeviceAlarmQuery
    • DeviceCamCountSaveCommand
    • CommonResult«List«LicensePieVO»»
    • ApiDeviceExpandConfigQuery
    • DeviceInfoSimpleVO
    • DeviceCamViewSaveCommand
    • LicensePieQuery
    • CommonResult«List«DeviceInfoSimpleVO»»
    • CommonResult«LicenseSumDTO»
    • DeviceInfoListQuery
    • ApiDeviceChannelSaveCommand
    • PageResult«DeviceInfoSimpleVO»
    • CommonResult«PageResult«DeviceInfoSimpleVO»»
    • DeviceIdOrNameLimitVO
    • DevicePageByCustomerIdQuery
    • CommonResult«List«DeviceIdOrNameLimitVO»»
    • DeviceShadowQuery
    • DeviceIdOrNameLimitQuery
    • CommonResult«List«DeviceShadowVO»»
    • DeviceTypeNickNameVO
    • DeviceShadowListQuery
    • CommonResult«List«DeviceTypeNickNameVO»»
    • DeviceShadowCustomerQuery
    • DeviceTypeNickNameQuery
    • DeviceZipVO
    • DeviceTypeNickNameSaveCommand
    • CommonResult«List«DeviceZipVO»»
    • DeviceParamQuery
    • DeviceShadowSimpleListQuery
    • DeviceLicenseRecordVO
    • SortParam
    • PageResult«DeviceLicenseRecordVO»
    • DeviceShadowSimpleCustomerQuery
    • CommonResult«PageResult«DeviceLicenseRecordVO»»
    • DeviceLicenseRecordQuery
    • DeviceLicenseHistoryVO
    • DeviceInfoAddCommand
    • PageResult«DeviceLicenseHistoryVO»
    • CommonResult«DeviceInfoVO»
    • CommonResult«PageResult«DeviceLicenseHistoryVO»»
    • DeviceInfoQuery
    • DeviceLicenseHistoryQuery
    • DeviceTripSaveCommand
    • DeviceInfoSaveCommand
    • DeviceInfoMoveCommand
    • DeviceCommandSendCommand
    • DeviceCommandsSendCommand
    • DeviceCommandTypeUpdateCommand
    • DeviceCommandSaveCommand
    • DeviceCommandStatusQueryCommand
    • DeviceCommandVO
    • PageResult«DeviceCommandVO»
    • CommonResult«PageResult«DeviceCommandVO»»
    • DeviceCommandPageQuery
    • CommonResult«List«DeviceCommandVO»»
    • DeviceCommandRecentlyQuery
    • DeviceTypeQuery
    • DeviceTypeVO
    • CommonResult«DeviceTypeVO»
    • DeviceTypeCommandQuery
  1. command

getConfig

POST
/v2/openapi/device/command/getConfig
Get device configuration parameters (basic parameters/network/audio and video/ADAS/DMS)

Request

Authorization
Add parameter in header
Authorization
Example:
Authorization: ********************
Header Params

Body Params application/json

Example
{
    "deviceId": "string"
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://mettahub.mettaxiot.com/gps/v2/openapi/device/command/getConfig' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "deviceId": "string"
}'

Responses

🟢200OK
application/json
Body

Example
{
    "code": 0,
    "data": {
        "basicDetail": {
            "heartbeatInterval": "",
            "sleepInterval": "",
            "emergencyInterval": "",
            "defaultTimeInterval": "",
            "maxSpeed": "",
            "overspeedDuration": "",
            "continuousDrivingTimeThreshold": "",
            "todayDrivingTimeThreshold": "",
            "minimumRestTime": "",
            "maximumParkingTime": "",
            "collisionTime": "",
            "collisionAcceleration": "",
            "rolloverAlarmSettings": "",
            "graphicVideoQuality": "",
            "brightness": "",
            "contrast": "",
            "saturation": "",
            "chroma": "",
            "vehicleOdometerReading": "",
            "gnssLocationMode": "",
            "gnssBaudRate": "",
            "gnssOutputFrequency": "",
            "gnssGatherFrequency": "",
            "alarmShootingSwitch": "",
            "alarmStorageIdentification": "",
            "keyFlag": ""
        },
        "network": {
            "mainServerAPN": "",
            "mainServerUsername": "",
            "mainServerPassword": "",
            "mainServerAddress": "",
            "backupServerAddress": "",
            "serverTCPPort": ""
        },
        "video": {
            "channel1Switch": false,
            "channel2Switch": false,
            "channel3Switch": false,
            "channel4Switch": false,
            "channel5switch": false,
            "channel1StorageFlag": false,
            "channel2StorageFlag": false,
            "channel3StorageFlag": false,
            "channel4StorageFlag": false,
            "channel5StorageFlag": false,
            "timingUnit": 0,
            "timingInterval": 0,
            "liveStreamMode": 0,
            "streamResolution": 0,
            "streamInterval": 0,
            "streamFrameRate": 0,
            "streamBitRate": 0,
            "storageStreamMode": 0,
            "storageResolution": 0,
            "storageInterval": 0,
            "storageFrameRate": 0,
            "storageBitRate": 0,
            "osdSubtitleSetting": 0,
            "enableAudioOutput": 0,
            "audioVideoTotal": 0,
            "audioTotal": 0,
            "videoTotal": 0
        },
        "advancedDriverAssistanceSystem": {
            "alarmSpeed": 0,
            "alarmVolume": 0,
            "activePhotoStrategy": 0,
            "timingPhotoInterval": 0,
            "distancePhotoInterval": 0,
            "activePhotoNumber": 0,
            "activePhotoInterval": 0,
            "photoResolution": 0,
            "videoResolution": 0,
            "alarmEnable": 0,
            "eventEnable": 0,
            "reserved": 0,
            "obsDistance": 0,
            "obsSpeed": 0,
            "obsVideoTime": 0,
            "obsPhotoNumber": 0,
            "obsPhotoInterval": 0,
            "fclTimeFrame": 0,
            "fclJudgmentNumber": 0,
            "fclSpeed": 0,
            "fclVideoTime": 0,
            "fclPhotoNumber": 0,
            "fclPhotoInterval": 0,
            "ldwSpeed": 0,
            "ldwVideoTime": 0,
            "ldwPhotoNumber": 0,
            "ldwPhotoInterval": 0,
            "fcwTime": 0,
            "fcwSpeed": 0,
            "fcwAlarmVideoTime": 0,
            "fcwAlarmPhotoNumber": 0,
            "fcwPhotoInterval": 0,
            "pcwTime": 0,
            "pcwSpeed": 0,
            "pcwVideoTime": 0,
            "pcwPhotoNumber": 0,
            "pcwPhotoInterval": 0,
            "dvwDistance": 0,
            "dvwSpeed": 0,
            "dvwVideoTime": 0,
            "dvwPhotoNumber": 0,
            "dvwPhotoInterval": 0,
            "tsrPhotoNumber": 0,
            "tsrPhotoInterval": 0,
            "reserved1": 0
        },
        "driverStatusMonitoringSystem": {
            "alarmSpeed": 0,
            "alarmVolume": 0,
            "activePhotoStrategy": 0,
            "activeTimingPhotoInterval": 0,
            "activeDistancePhotoInterval": 0,
            "singleActivePhotoNumber": 0,
            "singleActivePhotoInterval": 0,
            "photoResolution": 0,
            "videoRecordingResolution": 0,
            "alarmEnable": 0,
            "eventEnable": 0,
            "smokingAlarmInterval": 0,
            "callAlarmInterval": 0,
            "reserved": "",
            "bawsSpeed": 0,
            "bawsVideoTime": 0,
            "bawsPhotoNumber": 0,
            "bawsPhotoInterval": 0,
            "callSpeed": 0,
            "callVideoTime": 0,
            "callPhotoNumber": 0,
            "callPhotoInterval": 0,
            "smokingSpeed": 0,
            "smokingVideoTime": 0,
            "smokingPhotoNumber": 0,
            "smokingPhotoInterval": 0,
            "ddpSpeed": 0,
            "ddpVideoTime": 0,
            "ddpPhotoNumber": 0,
            "ddpPhotoInterval": 0,
            "dabSpeed": 0,
            "dabVideoTime": 0,
            "dabPhotoNumber": 0,
            "adabPhotoInterval": 0,
            "driverIdentificationTrigger": 0,
            "reservedField": 0
        },
        "blindSpotMonitoringSystem": {
            "rearIsApproachingTheAlarmTime": "",
            "sideIsApproachingTheAlarmTime": ""
        }
    },
    "msg": ""
}
Modified at 2025-09-12 09:50:32
Previous
cutOilElectric
Next
devicePage
Built with