播放盒开放接口
    播放盒开放接口
    • 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

    常见问题

    1. 连接报错“错误:connect ECONNREFUSERD ip:port”
    (1)请先确认播放盒设备与客户端是否处于同一局域网,是否可以在客户端ping通当前播放盒设备的ip,或在播放盒设备端ping客户端的ip
    (2)请确认端口与设备搜索返回的http端口是否一致
    2. 返回body返回错误“{"code:1,"message":"request error"}”
    系统异常,若无法恢复,可以先进行重启
    3. 返回body返回错误“{"code:12,"message":"not find command with path = /v1/login"}”
    系统中未实现当前请求接口
    4. 返回body返回错误“{"code:39,"message":"login expired,please login again"}”
    当前token登录过期,需要重新登录获取token
    5.定时策略Cron使用建议
    (1)cron从左到右(用空格隔开):
    秒 分 小时 月份中的日期 月份 星期中的日期 年份
    Seconds Minutes Hours DayofMonth Month DayofWeek Year
    字段允许值允许的特殊字符
    秒(Seconds)0~59的整数暂时只支持数字
    分(Minutes0~59的整数暂时只支持数字
    小时(Hours)0~23的整数暂时只支持数字
    日期(DayofMonth)1~31的整数,- * ? / L W C 八个字符
    月份(Month)1~12的整数或者 JAN-DEC, - * / 四个字符
    星期(DayofWeek)1~7的整数或者 SUN-SAT (1=SUN)(SUN MON TUE WED THU FRI SAT ), - * ? / L C # 八个字符
    年(可选,留空)(Year)1970~2099, - * / 四个字符
    星期一 MON 星期二 TUE 星期三 WED 星期四 THU 星期五 FRI 星期六 SAT 星期天 SUN
    6.设备搜索问题
    如果不在同一个子网下,可以指定IP搜索,需要将期望搜到的IP地址加入到搜索设备方法中的iplist参数,调用搜索接口以后,接口会返回这些ip中在线设备的设备信息。
    例如:将ip地址(192.168.1.101)加入到搜索设备方法的iplist参数中,将会定向搜索并返回该ip下的在线设备信息
    修改于 2024-10-14 03:03:08
    上一页
    状态码列表
    下一页
    获取显示屏用户信息
    Built with