1. custom upload
IotHub
  • README
  • token
    • createToken
      POST
    • destroyToken
      POST
  • customer
    • customerPage
      POST
    • customerTree
      POST
  • device
    • command
      • commandSend
      • commandInfoList
      • cutOilElectric
      • getConfig
    • devicePage
      POST
    • deviceTypes
      POST
    • deviceTypeInfo
      POST
    • deviceDataByDeviceIds
      POST
    • deviceDataByCustomerId
      POST
    • deviceTripInfoByTripId
      POST
    • deviceTripsByDeviceId
      POST
    • deviceTraffic
      POST
    • deviceSensorData
      POST
    • expandInfoByDeviceId
      POST
    • saveDeviceChannelName
      POST
  • fence
    • fencePage
    • fenceInfo
    • addFence
    • saveFence
    • delFence
    • fenceDevices
    • fenceDeviceUpdate
    • fenceDeviceDel
    • fenceDeviceAdd
  • push&Webhook
    • README
  • video
    • history
      • README
      • H5 Page
      • custom upload
        • customHistoricalUploadStop
          POST
        • customHistoricalUpload
          POST
      • playBackList
        POST
      • historicalUpload
        POST
      • playBack
        POST
      • replaySet
        POST
      • taskPage
        POST
      • taskStop
        POST
      • taskDelete
        POST
    • live
      • README
      • H5 Page-V2[Recommend]
      • H5 page
      • liveVideo
      • liveVideoControl
    • getNodes
      POST
  • alarm
    • Alert Types
    • alarmTypeList
    • alarmFilePage
    • alarmFileByAlarmId
    • alarmHistoryPage
    • alarmPageByUser
    • alarmFileRecordReUpload
  • 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»»
    • ApiVideoCustomUploadStopCommand
    • 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«ApiVideoCustomHistoryUploadVO»
    • 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
    • ApiVideoCustomUploadCommand
    • ApiDestroyTokenCommand
    • CommonResult«List«ApiCustomerVO»»
    • CommonResult«List«String»»
    • CommonResult«ApiFenceInfoVO»
    • DeviceDataVO
    • ApiVideoHistoryQuery
    • LicenseInfoVO
    • ApiAlarmTypeVO
    • ApiDeviceCommandRecentlyQuery
    • AudioTalkV3Command
    • ApiAudioTalkCommand
    • CommonResult«Boolean»
    • ApiVideoCustomHistoryUploadVO
    • 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
    • ApiVideoHistoryM3u8VO
    • ApiDeviceGpsTripVO
    • CommonResult«DeviceShadowVO»
    • LicenseMoveHistoryPageQuery
    • VideoLiveVO
    • PageResult«ApiAlarmInfoVO»
    • ApiDeviceSensorDataVO
    • CommonResult«ApiVideoHistoryM3u8VO»
    • 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. custom upload

customHistoricalUpload

Singapore
https://mettahub.mettaxiot.com/gps
Singapore
https://mettahub.mettaxiot.com/gps
POST
/v2/openapi/video/custom/history/upload

1.The minimum interval for requests with the same parameters is 10 seconds. 2.The duration of a single uploaded file shall not exceed 10 minutes. 3.Please save the deviceId and uuid returned by this interface, as these parameters are required when canceling the upload. 4.Please listen for upload start, failure, and upload success events on your FTP server for file status management.

Request

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

Body Params application/json

Example
{
    "deviceId": "string",
    "channelId": 0,
    "startTime": "string",
    "endTime": "string",
    "ftpIp": "string",
    "ftpPort": 0,
    "ftpUserName": "string",
    "ftpPassword": "string",
    "ftpUploadFilePath": "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/video/custom/history/upload' \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "deviceId": "string",
    "channelId": 0,
    "startTime": "string",
    "endTime": "string",
    "ftpIp": "string",
    "ftpPort": 0,
    "ftpUserName": "string",
    "ftpPassword": "string",
    "ftpUploadFilePath": "string"
}'

Responses

🟢200
application/json
Body

Example
{
  "code": 0,
  "data": {
    "deviceId": "",
    "uuid": ""
  },
  "msg": ""
}
Modified at 2026-03-20 06:25:47
Previous
customHistoricalUploadStop
Next
playBackList
Built with