播放盒-EN
  1. Screen control-related
播放盒-EN
  • API access guide
  • Common Error Codes
  • FAQ
  • User-related
    • Log in to devices
      POST
    • Log out of the device
      DELETE
    • Change user information
      PUT
  • System control-related
    • Screenshot
      GET
    • Restart the device immediately
      POST
    • Obtain device restart schedules
      GET
    • Schedule device restarts
      POST
    • Set time
      POST
    • Install apps
      PUT
    • Obtain time
      GET
    • Factory reset
      PUT
    • Obtain terminal information
      GET
    • Obtain volume
      GET
    • Set volume
      POST
    • Upgrade the device
      PUT
    • Check local upgrade status
      GET
  • Screen control-related
    • Receiving card-related
      • Obtain receiving card connection information
      • Obtain receiving card monitoring information
      • Obtain basic information of the receiving card
      • Configure the screen via receiving card configuration (send .rcfgx file)
      • Configure the screen via receiving card configuration (send .scr file)
      • Upgrade the receiving card
      • Obtain the receiving card upgrade progress
    • Send Card-related
      • Obtain the basic Information of the sending card
    • Obtain screen brightness
      GET
    • Set screen brightness
      POST
    • Obtain screen status
      GET
    • Set screen status
      POST
    • Obtain screen-on/off schedules
      GET
    • Set screen-on/off schedules
      POST
    • Set brightness adjustment schedules
      POST
    • Obtain brightness adjustment schedules
      GET
  • General capabilities
    • Upload files
    • Download files
  • Serial port control
    • Activate RS-485 serial communication
    • Check RS-485 serial port status
  • Board relays
    • Obtain relay information
    • Set relay information
  1. Screen control-related

Set screen-on/off schedules

POST
/terminal/core/v1/screen/power-policy
Last modified:2024-08-23 08:27:29
Set screen-on/off schedules

Request

Header Params
Content-Type
string 
optional
Example:
application/json
Authorization
string 
optional
Default:
1724333189506EO5Zqpduu4+azwYYXMJJhg==
Body Params application/json
conditions
array [object {3}] 
Policy collection
required
cron
array[string]
Time
required
cron expression, representing the specific task execution time
action
string 
Task behavior
required
"OPEN": Screen on, "CLOSE": Screen off
enable
boolean 
Task status
required
Whether to execute the current task, true: Start execution, false: Stop execution
Example
{
  "enable": true,
  "conditions": [
    {
      "cron": [
        "0 0 0 ? * * *"
      ],
      "action": "OPEN",
      "enable": true
    }
  ]
}

Request 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://192.168.0.10:16674/terminal/core/v1/screen/power-policy' \
--header 'Authorization: 1724333189506EO5Zqpduu4+azwYYXMJJhg==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "enable": true,
    "conditions": [
        {
            "cron": [
                "0 0 0 ? * * *"
            ],
            "action": "OPEN",
            "enable": true
        }
    ]
}'

Responses

🟢200Success
application/json
Body
code
integer 
Status code
required
0：Success
message
string 
Detailed information
required
Detailed information
Example
{
  "code": 0,
  "message": ""
}
Previous
Obtain screen-on/off schedules
Next
Set brightness adjustment schedules
Built with