播放盒开放接口
    播放盒开放接口
    • API接入指南
    • 状态码列表
    • 常见问题
    • 用户相关
      • 获取显示屏用户信息
        GET
      • 修改显示屏用户信息
        POST
      • 登录设备
        POST
      • 登出设备
        DELETE
      • 修改用户信息
        PUT
    • 系统控制相关
      • 设备截图
        GET
      • 设备立即重启
        POST
      • 获取设备定时重启策略
        GET
      • 设置设备定时重启策略
        POST
      • 设置时间
        POST
      • 安装App
        PUT
      • 获取时间
        GET
      • 获取正在运行的APP版本信息
        GET
      • 停止运行APP
        PUT
      • 卸载APP
        PUT
      • 获取已安装的APP信息
        GET
      • 获取终端已配置的传感器信息
        GET
      • 设置终端已连接的传感器信息
        POST
      • 获取已安装的软件版本信息
        PUT
      • 获取设备信息
        GET
      • 获取设备能力集
        GET
      • 获取在线NTP校时配置
        GET
      • 设置在线NTP校时配置
        POST
      • 清除所有媒体
        POST
      • 升级可行性判断
        PUT
      • 获取WIFI列表
        GET
      • 连接WI-FI
        POST
      • 断开W-IFI连接
        POST
      • 获取WI-FI-STA开启状态
        GET
      • 设置WI-FI-STA开启状态
        POST
      • 忘记WI-FI密码
        POST
      • 获取有线网络信息
        GET
      • 设置有线网络信息
        POST
      • 获取AP开关状态
        GET
      • 设置AP开关状态
        POST
      • 获取硬盘存储信息
        GET
      • 获取CPU使用率
        GET
      • 获取CPU温度
        GET
      • 获取内存信息
        GET
      • 获取是否夏令时
        GET
      • 获取播放日志路径
        GET
      • 获取终端日志路径
        GET
      • 设置终端电源模式
        POST
      • 获取终端电源模式
        GET
      • 获取屏老板绑定信息
        GET
      • 设置屏老板绑定信息
        POST
      • 设置定时音量策略
        POST
      • 获取定时音量策略
        GET
      • 恢复出厂设置
        PUT
      • 获取终端信息
        GET
      • 获取音量
        GET
      • 设置音量
        POST
      • 设备升级
        PUT
      • 检查本地升级状态
        GET
      • 获取标签定时任务
        GET
      • 设置标签定时任务
        POST
      • 节目暂停
        PUT
    • 显示屏控制相关
      • 接收卡相关
        • 获取接收卡的温度或电压
        • 获取接收卡的连接信息
        • 获取接收卡的监控信息
        • 获取接收卡基本信息
        • 接收卡点屏(下发.rcfgx文件)
        • 接收卡配屏(下发.scr文件)
        • 接收卡升级
        • 获取接收卡升级进度
        • 箱体点检开始
        • 获取箱体点检结果
      • 发送卡相关
        • 获取发送卡的监控信息
        • 获取发送卡基本信息
      • 获取显示屏亮度
      • 设置显示屏亮度
      • 获取显示屏屏幕状态
      • 设置显示屏屏幕状态
      • 获取屏幕定时开关策略
      • 设置屏幕定时开关策略
      • 设置定时亮度策略
      • 获取定时亮度策略
      • 获取视频源列表信息
      • 切换视频源
      • 获取外源分辨率
      • 设置外源分辨率
      • 设置屏幕旋转
      • 获取屏幕旋转
      • 获取窗口大小
      • 设置亮度模式
      • 获取亮度模式
      • 获取环境亮度
      • 获取色温
      • 设置色温
      • 设置屏幕状态模式
      • 获取屏幕状态模式
      • 设置同步播放开关
      • 获取同步播放配置
      • 设置内源预设分辨率
      • 获取内源分辨率
      • 获取内源预设分辨率列表
      • 设置内源自定义分辨率
    • 通用能力
      • 获取终端支持的字体
      • 删除字体
      • 更新字体
      • 上传文件
      • 下载文件
    • 串口控制
      • 启用485串口功能
      • 获取485串口状态
    • 多功能卡相关
      • 设置手动多功能卡电源控制任务
      • 获取多功能卡电源状态
      • 设置定时多功能卡电源控制任务
      • 获取定时多功能卡电源控制任务
    • 本板继电器
      • 获取本板电源信息
      • 设置本板电源信息
    • 数据模型
      • Schemas
        • SetVideoSourceRequest
        • VpnConnectionInfo
        • ApiResponse
        • MultiFunctionRelayManual
        • SupportFunctionResponse
        • PlayLogResponse
        • GetPowerPolicyResponse
        • RunningAppsResponse
        • VideoSourceListResponse
        • UninstallAppRequest
        • ProductDeviceResponse
        • SetSensorConfigRequest
        • SensorConfigResponse
        • UpdateFontRequest
        • DeleteFontRequest
        • MultiFunctionRelayResponsePolicy
        • GetHDMIResolutionRequest
        • GetFunctionRelayStatusResponse
        • ScreenUserInfoResponse
        • SoftwareVersionResponse
        • StopAppRequest
        • DisplayMode
        • SetHDMIResolutionRequest
        • AllAppsResponse
        • SupportFontsResponse
        • GetCareConfigResponse
        • AppInfo
        • WifiState
        • GetNativeRelayPolicyResponse
        • RotationResponse
        • NtpConfigResponse
        • NtpConfigBean
        • Source
        • RelayInfoBean
        • FunctionRelayControl
        • VideoSource
        • ProductDeviceInfo
        • RotationBean
        • SensorInfo
        • FontToUpdate
        • FontToDelete
        • PowerCondition
        • ResolutionResponse
        • PowerState
        • ScreenUserInfo
        • RequestPackageBean
        • BaseResponse
        • FontInfo
        • LanguageBean
        • AppPackageInfo
        • LocalRelayPolicy
        • SyncMessageStatus
        • VpnInfo
        • ResponseResult
        • Resolution
        • ProductDeviceBean
        • ProductInfo
        • SourceInfo
        • RegisterAddressInfo
        • SoftwareBean
        • CareConfig
        • ConnectInfo
        • HDMIInfo
        • HdmiInfo
        • DeviceConfigBean
        • ConfigInfo
        • ErrorResponse
        • SoftwareResult
        • CareServerUrl
        • NetworkInfo
        • PortConfigInfo
        • PortConfig
        • RunningDeviceBean
      • Response
        • ResponseSuccess
        • ResponseInvalidJson
        • ResponseUnsupported
        • ResponseInvalidParams
        • ResponseHardwareError
        • ResponseLoraVolumeSyncError
        • ResponseAccountNotExist
        • ResponseError
        • ResponseScreenNotConfig

    状态码列表

    错误码名称描述
    0OK成功
    1ERROR失败
    2ERR_NULL参数为空
    3ERR_INVALID_PARAM无效参数
    4ERR_TIMEOUT超时异常
    5ERR_IO_EXCEPTIONIO异常
    6ERR_INTERRUPTED中断异常
    7ERR_INCOMPLETED未完成
    9ERR_ALREADY_DONE已经执行过
    10ERR_SECURITY安全性异常
    11ERR_PERMISSION_DENIED权限不够
    12ERR_NOT_IMPLEMENTED未实现的功能
    13ERR_REMOTE_EXCEPTION远程过程调用异常,一般用于进程间通信异常
    16ERR_JSON_EXCEPTIONJson异常
    17ERR_FORBIDDEN禁止访问
    18ERR_NO_SESSION未连接异常
    19ERR_NOT_EXISTED不存在的异常
    20ERR_NO_SPACE空间不足
    21ERR_DATABASE_EXCEPTION数据库操作
    22ERR_TOO_FREQUENTLY过于频繁操作
    23ERR_ALREADY_EXISTED已存在
    24ERR_VERIFY_FAILED验证失败
    25ERR_FILE_ILLEGAL文件异常
    32ERR_SIGNATURE_NO_MATCH签名不匹配(升级包)
    33ERR_ACCOUNT_NOT_EXIST账号不存在
    35ERR_NETWORK网络异常
    36ERR_UNSUPPORTED当前功能不支持时抛出该异常
    38ERR_VISIT_HARDWARE访问硬件错误
    66ERR_EXCEED_LIMIT超出限制异常
    67ERR_SERVICE_NOT_STARTED服务未启动的异常
    68ERR_NOT_FOUND未找到目标的异常
    修改于 2024-08-22 14:29:39
    上一页
    API接入指南
    下一页
    常见问题
    Built with