播放盒-EN
    播放盒-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

    Common Error Codes

    Error CodeNameDescriptionDescription
    0OKSuccess
    1ERRORFailure
    2ERR_NULLThe parameter is empty.
    3ERR_INVALID_PARAMInvalid parameter
    4ERR_TIMEOUTTimeout exception
    5ERR_IO_EXCEPTIONIO exception
    6ERR_INTERRUPTEDInterrupted exception
    7ERR_INCOMPLETEDIncomplete
    9ERR_ALREADY_DONEAlready done
    10ERR_SECURITYSecurity exception
    11ERR_PERMISSION_DENIEDPermission denied
    12ERR_NOT_IMPLEMENTEDFunction not implemented
    13ERR_REMOTE_EXCEPTIONRemote procrdure call exception.Commonly used for the communication exception between processes
    16ERR_JSON_EXCEPTIONJson exception
    17ERR_FORBIDDENAccess forbidden
    18ERR_NO_SESSIONNo session connection
    19ERR_NOT_EXISTEDNot exist
    20ERR_NO_SPACEInsufficient storage space
    21ERR_DATABASE_EXCEPTIONDatabase operation exception
    22ERR_TOO_FREQUENTLYToo many requests
    23ERR_ALREADY_EXISTEDAlready exists
    24ERR_VERIFY_FAILEDVerification failed
    25ERR_FILE_ILLEGALInvalid file
    32ERR_SIGNATURE_NO_MATCHSignature not match (upgrade package)
    33ERR_ACCOUNT_NOT_EXISTAccount not exist
    35ERR_NETWORKNetwork error
    36ERR_UNSUPPORTEDThis exception is thrown when the current function is not supported.
    38ERR_VISIT_HARDWAREHardware access error
    66ERR_EXCEED_LIMITLimit exceeded
    67ERR_SERVICE_NOT_STARTEDService not started
    68ERR_NOT_FOUNDTarget not found
    Previous
    API access guide
    Next
    FAQ
    Built with