1. Scheduler-V3
FoxCloud OpenAPI
Full API Reference
  • Vpp Flow
  • Full API Reference
  • Power Station
    • Get power station list
      POST
    • Get power station detail
      GET
    • Create power station
      POST
    • Delete power station
      POST
    • Edit power station
      POST
  • VPP
    • authorization code mode offboard by sn
      POST
    • client mode offboard
      POST
    • client mode onboard
      POST
  • Inverter-V1
    • Get device setting capabilities
      POST
    • Read device settings
      POST
    • Write device settings
      POST
    • Get device detail
      GET
    • Get device real-time data
      POST
  • Inverter
    • Get device list
      POST
    • Get device detail (Deprecated)
      GET
    • Get available variables
      GET
    • Get error code information
      GET
    • Get device real-time data (Deprecated)
      POST
    • Get device history data
      POST
    • Get device production report
      POST
    • Get device power generation
      GET
    • Get the minimum soc settings for the battery of device
      GET
    • Set the minmum soc for the battery of the device
      POST
    • Get the setting of battery charging time
      GET
    • Set the battery charging time
      POST
    • Get the device settings item
      POST
    • Set the device settings item
      POST
    • Get the device time
      POST
    • Set the device time
      POST
    • Get the device peakshaving settings
      POST
    • Set the device peakshaving settings
      POST
    • Get the Meter Reader
      POST
    • Set the Meter Reader
      POST
    • Get battery heating Parameter
      POST
    • Set battery heating Parameter
      POST
    • Get display sleep Paeameter
      POST
    • Set display sleep Paeameter
      POST
    • Get the device third party PV Integration status
      GET
    • Get Device Fault History
      POST
    • Get device PV power generation
      GET
  • Scheduler-V3
    • Get the time segment information
      POST
    • Set the time segment information
      POST
    • Batch set the time segment information
      POST
  • Scheduler-V2
    • Get the time segment information
    • Set the time segment information
  • Scheduler-V1
    • Get the main switch status
    • Set the main switch status
    • Get the time segment information
    • Set the time segment information
  • Scheduler (Deprecated)
    • Get the main switch status (Deprecated)
    • Get the time segment information (Deprecated)
    • Set the main switch status (Deprecated)
    • Set the time segment information (Deprecated)
  • Data Logger
    • Get Data Logger list
    • Get Data Logger Details
    • Get Data Logger Signal
    • Get Data Logger Wifi Info
    • Get Data Logger Lan Info
  • EMS
    • Get Ems list
    • Get Ems real-time data
    • Get Ems history data
    • Get Ems System Setting
    • Set Ems System Setting
    • Get Ems Rate Setting
    • Set Ems Rate Setting
    • Set Ems Ac Output Control Setting
    • Get Ems Ac Output Control Setting
    • Set Ems Power Limit Control Setting
    • Get Ems Power Limit Control Setting
    • Set Ems More Setting
    • Get Ems More Setting
    • Set Ems Gen Setting
    • Get Ems Gen Setting
  • Meter
    • Get meter list
    • Get the device settings item
    • Set the device settings item
  • Heat
    • genericControlsGet
    • genericControlsSet
    • heatingControlsGet
    • heatingControlsSet
    • heatingCircuitsControlsGet
    • heatingCircuitsControlsSet
    • dhwControlsGet
    • dhwControlsSet
    • heatAssetList-OAuth flow unsupported
    • changeKafkaPushStatus-OAuth flow unsupported
  • Schemas
    • CapabilityRequest
    • batteryList
    • HeatAssetListParam
    • CapabilityResponse
    • Result
    • CapabilityResult
    • CapabilityGroup
    • WeComLoginRequest
    • CapabilityField
    • ResponseInfo
    • ValueRange
    • Holiday
    • SettingGetRequest
    • DailyTimer
    • SettingGetResponse
    • GenericControlsData
    • SettingGetResult
    • GenericControlsParam
    • SettingSetRequest
    • WeekTimerItem
    • SettingSetResponse
    • HeatingControlsData
    • HeatingControlsParam
    • CircuitActivation
    • CircuitType
    • HeatingCircuitsControlsParam
    • DhwControlsData
    • DhwControlsParam
    • HolidayAway
    • HolidayHome
    • HeatKafkaPushStatusParam
    • TimerItem
    • DailyTimerTimerItem
    • DhwTimerItem
    • DailyTimerDhwTimerItem
    • TimerItem
    • DailyTimer
    • WeeklyTimer
    • DailyTimerTimerItem
    • BivalencePoint
    • DhwTimerItem
    • AuxiliaryHeaterSettings
    • DailyTimerDhwTimerItem
    • WeeklyTimerWeekTimerItem
    • BaseWeekTimerItem
    • WeeklyTimerBaseWeekTimerItem
    • CureSetting
    • HeatingCurves
    • HeatingCircuitsControlsData
    • TimerItem
    • DailyTimer
    • BivalencePoint
    • AuxiliaryHeaterSettings
  1. Scheduler-V3

Batch set the time segment information

POST
/op/v3/device/scheduler/enable/batch
This API is used to batch configure Scheduler V3 time segment settings for multiple devices asynchronously.The system first validates all request parameters, device serial numbers, and access permissions. The validation is all-or-nothing: if any device is invalid, unauthorized, or any scheduler time segment is invalid, the entire request is rejected and no task is submitted.After validation succeeds, the system accepts the batch request, splits it into individual device tasks, and submits them for asynchronous execution. The API returns immediately with ACCEPTED; it does not wait for all devices to finish.
If notifyChannel is none, no completion notification is sent.
If notifyChannel is webhook, a webhook notification is sent after all device tasks are completed.
Webhook Signature Verification Steps
1.
Read X-Foxess-Timestamp, X-Foxess-Nonce, and X-Foxess-Signature.
2.
Reject the request if any of these headers are missing.
3.
Optionally reject the request if the timestamp is too old, for example older than 1 Hour.
4.
Build the string to sign: timestamp + "\n" + nonce + "\n" + rawBody
5.
Calculate HMAC-SHA256 using the webhook secret.
6.
Hex-encode the result in lowercase.
7.
Compare it with the value after sha256= in X-Foxess-Signature.
8.
Use constant-time comparison to avoid timing attacks.
9.
Use X-Foxess-Event-Id for idempotency. If the same event ID is received again, it should not be processed twice.
Supported value ranges and enums for the scheduling parameters (work mode and extra parameters) vary by device model. Query the Get interface first, and set values based on the properties returned in its response (per-field enumList and range).

Request

Authorization
or
Header Params

Body Params application/json

Example
{
    "requestId": "string",
    "notifyChannel": "string",
    "deviceSNList": [
        "string"
    ],
    "groups": [
        {
            "startHour": 0,
            "startMinute": 0,
            "endHour": 0,
            "endMinute": 0,
            "workMode": "string",
            "extraParam": {
                "minSocOnGrid": 0,
                "fdSoc": 0,
                "fdPwr": 0,
                "maxSoc": 0,
                "importLimit": 0,
                "exportLimit": 0,
                "pvLimit": 0,
                "reactivePower": 0,
                "secondWorkMode": "string"
            }
        }
    ],
    "isDefault": true,
    "webhook": {
        "url": "string",
        "secret": "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 '/op/v3/device/scheduler/enable/batch' \
--header 'token;' \
--header 'signature;' \
--header 'timestamp;' \
--header 'lang: en' \
--header 'Content-Type: application/json' \
--data '{
    "requestId": "string",
    "notifyChannel": "string",
    "deviceSNList": [
        "string"
    ],
    "groups": [
        {
            "startHour": 0,
            "startMinute": 0,
            "endHour": 0,
            "endMinute": 0,
            "workMode": "string",
            "extraParam": {
                "minSocOnGrid": 0,
                "fdSoc": 0,
                "fdPwr": 0,
                "maxSoc": 0,
                "importLimit": 0,
                "exportLimit": 0,
                "pvLimit": 0,
                "reactivePower": 0,
                "secondWorkMode": "string"
            }
        }
    ],
    "isDefault": true,
    "webhook": {
        "url": "string",
        "secret": "string"
    }
}'

Responses

🟢200成功
application/json
Bodyapplication/json

Example
{
    "errno": 0,
    "msg": "string",
    "result": {
        "requestId": "string",
        "status": false,
        "total": "string",
        "accepted": "string"
    }
}
Modified at 2026-09-17 07:28:25
Previous
Set the time segment information
Next
Get the time segment information
Built with