多媒体平台 MQTT API 1.0.0

Accepts the following message:

{
  "allow_anonymous": true,
  "product": [
    {
      "expired_date": "string",
      "product_id": 0
    }
  ]
}

Accepts the following message:

Accepts one of the following messages:

• #0shutdown关机

  Payload

  object

  event

  string

  Allowed values:
  • "shutdown"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "shutdown",
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #1reboot重启设备

  Payload

  object

  event

  string

  Allowed values:
  • "reboot"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "reboot",
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #2forceUpdate强制更新

  Payload

  object

  event

  string

  Allowed values:
  • "forceUpdate"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "forceUpdate",
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #3backlight定时开关屏

  推送的同时需要写入到配置中，开机获取

  Payload

  object

  event

  string

  Allowed values:
  • "backlight"

  content

  array<object>

  uid: backlightInfo

  startTime

  string

  uid: startTime

  开始时分时间，如 "08:00"

  endTime

  string

  uid: endTime

  结束时分时间，结束时间必须大于开始时间，如 "10:00"

  week

  string

  uid: week

  星期几，0是周日

  Allowed values:
  • "0"
  • "1"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "backlight",
    "content": [
      {
        "startTime": "string",
        "endTime": "string",
        "week": "0"
      }
    ],
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #4disableBacklight设备关屏

  Payload

  object

  event

  string

  Allowed values:
  • "disableBacklight"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "disableBacklight",
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #5enableBacklight设备开屏

  Payload

  object

  event

  string

  Allowed values:
  • "enableBacklight"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "enableBacklight",
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #6diskInfo查询磁盘信息

  需要上报服务器

  Payload

  object

  event

  string

  Allowed values:
  • "diskInfo"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "diskInfo",
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #7downloadInfo查询下载信息

  客户端上报下载进度给服务器

  Payload

  object

  event

  string

  Allowed values:
  • "downloadInfo"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "downloadInfo",
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #8screenCap设备截图

  客户端上传截图文件后，上传结果上报给服务器

  Payload

  object

  event

  string

  Allowed values:
  • "screenCap"

  content

  object

  code

  number

  下载结果：

  • 0 上传成功
  • 其他均为失败

  Additional properties are allowed.

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "screenCap",
    "content": {
      "code": 0
    },
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #9screenRecord设备录屏

  客户端上传视频文件后，上传结果上报给服务器

  Payload

  object

  event

  string

  Allowed values:
  • "screenRecord"

  content

  object

  uid: screenRecordInfo

  duration

  number

  >= 1

  单位是秒

  Additional properties are allowed.

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "screenRecord",
    "content": {
      "duration": 1
    },
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #10marqueeLocation跑马灯位置

  跑马灯位置默认位于屏幕底部；写入到配置中，开机获取

  Payload

  object

  event

  string

  Allowed values:
  • "marqueeLocation"

  content

  object

  uid: marqueeLocationInfo

  marginBottom

  number

  单位px

  Additional properties are allowed.

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "marqueeLocation",
    "content": {
      "marginBottom": 0
    },
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #11timerSwitch设备定时开关机

  包含按周循环开关机和跨天开关机；写入到配置中，开机获取

  跨天开关机可以两种：

  • 指定时间段内某几天按周循环：比如5.1到6.20的每周一和周四上午六点开机，晚上十点关机，其余时间按照正常开关机设置进行
  • 精确到某天时分开关机时间：比如5.1关机，5.20开机

  Payload

  object

  event

  string

  Allowed values:
  • "timerSwitch"

  content

  object

  uid: timingInfo

  normal

  object

  正常按周循环数据

  startDate

  string

  跨天起始日期，如 "2021-05-01"

  endDate

  string

  跨天结束日期，如 "2021-05-010"

  days

  array<object>

  startTime

  string

  开机时分时间，如 "08:00"

  endTime

  string

  关机时分时间，关机时间必须大于开机时间，如 "10:00"

  week

  string

  uid: week

  星期几，0是周日

  Allowed values:
  • "0"
  • "1"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"

  Additional properties are allowed.

  crossDays

  array<object>

  跨天开关机

  startDate

  string

  跨天起始日期，如 "2021-05-01"

  endDate

  string

  跨天结束日期，如 "2021-05-010"

  days

  array<object>

  startTime

  string

  开机时分时间，如 "08:00"

  endTime

  string

  关机时分时间，关机时间必须大于开机时间，如 "10:00"

  week

  string

  uid: week

  星期几，0是周日

  Allowed values:
  • "0"
  • "1"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"

  Additional properties are allowed.

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "timerSwitch",
    "content": {
      "normal": {
        "startDate": "string",
        "endDate": "string",
        "days": [
          {
            "startTime": "string",
            "endTime": "string",
            "week": "0"
          }
        ]
      },
      "crossDays": [
        {
          "startDate": "string",
          "endDate": "string",
          "days": [
            {
              "startTime": "string",
              "endTime": "string",
              "week": "0"
            }
          ]
        }
      ]
    },
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #12brightness屏幕亮度

  包含精简模式和高级模式的亮度设置；写入到配置中，开机获取

  Payload

  object

  event

  string

  Allowed values:
  • "brightness"

  content

  array<object>

  uid: brightnessInfo

  startTime

  string

  uid: startTime

  开始时分时间，如 "08:00"

  endTime

  string

  uid: endTime

  结束时分时间，结束时间必须大于开始时间，如 "10:00"

  value

  number

  [ 0 .. 100 ]

  设备亮度

  week

  string

  uid: week

  星期几，0是周日

  Allowed values:
  • "0"
  • "1"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "brightness",
    "content": [
      {
        "startTime": "string",
        "endTime": "string",
        "value": 100,
        "week": "0"
      }
    ],
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #13volume设备音量

  包含精简模式和高级模式的音量设置；写入到配置中，开机获取

  Payload

  object

  event

  string

  Allowed values:
  • "volume"

  content

  array<object>

  uid: volumeInfo

  startTime

  string

  uid: startTime

  开始时分时间，如 "08:00"

  endTime

  string

  uid: endTime

  结束时分时间，结束时间必须大于开始时间，如 "10:00"

  value

  number

  [ 0 .. 100 ]

  设备音量

  week

  string

  uid: week

  星期几，0是周日

  Allowed values:
  • "0"
  • "1"
  • "2"
  • "3"
  • "4"
  • "5"
  • "6"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "volume",
    "content": [
      {
        "startTime": "string",
        "endTime": "string",
        "value": 100,
        "week": "0"
      }
    ],
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #14downloadSpeedLimit下载限速

  写入到配置中，开机获取

  Payload

  object

  event

  string

  Allowed values:
  • "downloadSpeedLimit"

  content

  object

  uid: downloadSpeedLimitInfo

  value

  number

  单位是k，0是不限速

  Additional properties are allowed.

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "downloadSpeedLimit",
    "content": {
      "value": 0
    },
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #15saveLog保存日志

  写入到配置中，开机获取

  Payload

  object

  event

  string

  Allowed values:
  • "saveLog"

  content

  object

  isSave

  boolean

  true是开启记录日志

  Additional properties are allowed.

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "saveLog",
    "content": {
      "isSave": true
    },
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #16fetchLog取日志

  客户端上传日志文件后，上传结果上报给服务器

  Payload

  object

  event

  string

  Allowed values:
  • "fetchLog"

  content

  object

  uid: fetchLogInfo

  url

  string

  日志文件上传路径

  Additional properties are allowed.

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: sender

  消息来源

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "fetchLog",
    "content": {
      "url": "string"
    },
    "time": 1621425835000,
    "sender": "string"
  }
  

  This example has been generated automatically.

• #17reload重载web程序

  当后台删除设备时发送该消息，终端刷新页面

  Payload

  object

  event

  string

  Allowed values:
  • "reload"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: serverSender

  消息来自Server

  Allowed values:
  • "server"

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "reload",
    "time": 1621425835000,
    "sender": "server"
  }
  

  This example has been generated automatically.

Accepts one of the following messages:

• #0uploadDiskInfo上传磁盘信息

  各个分区可用磁盘空间信息

  Payload

  object

  event

  string

  Allowed values:
  • "uploadDiskInfo"

  content

  array<object>

  path

  string

  分区路径

  totalSize

  number

  单位k，总磁盘空间

  availableSize

  number

  单位k，可用磁盘空间

  deviceID

  string

  uid: deviceID

  设备的唯一ID，Android设备为Mac地址

  Examples values:
  • "DAFADC0A9311"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: androidSender

  消息来自Android设备

  Allowed values:
  • "android"

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "uploadDiskInfo",
    "content": [
      {
        "path": "string",
        "totalSize": 0,
        "availableSize": 0
      }
    ],
    "deviceID": "DAFADC0A9311",
    "time": 1621425835000,
    "sender": "android"
  }
  

  This example has been generated automatically.

• #1uploadDownloadInfo上传下载信息

  下载信息写入数据库后，通知给服务器实时更新UI。包含下载进度、下载结果

  Payload

  object

  event

  string

  Allowed values:
  • "uploadDownloadInfo"

  content

  array<object>

  progress

  number

  [ 1 .. 100 ]

  下载进度

  code

  number

  下载结果：

  • 0 下载成功
  • -1 下载中
  • 其他查询curl code

  deviceID

  string

  uid: deviceID

  设备的唯一ID，Android设备为Mac地址

  Examples values:
  • "DAFADC0A9311"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: androidSender

  消息来自Android设备

  Allowed values:
  • "android"

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "uploadDownloadInfo",
    "content": [
      {
        "progress": 1,
        "code": 0
      }
    ],
    "deviceID": "DAFADC0A9311",
    "time": 1621425835000,
    "sender": "android"
  }
  

  This example has been generated automatically.

• #2uploadDeviceInfo上传设备信息

  连接服务器成功后上报设备主板类型、内核版本、软件版本等信息给服务器

  Payload

  object

  event

  string

  Allowed values:
  • "uploadDeviceInfo"

  content

  object

  ip

  string

  设备IP

  mac

  string

  设备Mac

  systemVersion

  string

  系统版本号，比如 "7.1"

  kernelVersion

  string

  Android固件版本号，比如 "SHINE_PX30_10_TLD101HD403-Y_v1.6_210514"

  appVersion

  string

  程序版本号

  motherboard

  string

  芯片类型

  • XZ358: 芯智358
  • XZ928: 芯智928
  • XZ828: 芯智828
  • XZ938: 芯智938
  • XZ801: 芯智801
  • HS3719C: 海思3719C
  • HS3798M: 海思3798M
  • A64: A64主板
  • Langguo3288: 郎国3288
  • H6: H6主板
  • Langguo905: 郎国905
  • Langguo358: 郎国358
  • Langguo810: 郎国810
  • HAIXIN55: 海信55寸电视
  • HAIXIN21: 海信21寸电视
  • PX30: ap7/ap10

  Allowed values:
  • "XZ358"
  • "XZ928"
  • "XZ828"
  • "XZ938"
  • "XZ801"
  • "HS3719C"
  • "HS3798M"
  • "A64"
  • "Langguo3288"
  • "H6"
  • "Langguo905"
  • "Langguo358"
  • "Langguo810"
  • "HAIXIN55"
  • "HAIXIN21"
  • "PX30"

  Additional properties are allowed.

  deviceID

  string

  uid: deviceID

  设备的唯一ID，Android设备为Mac地址

  Examples values:
  • "DAFADC0A9311"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: androidSender

  消息来自Android设备

  Allowed values:
  • "android"

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "uploadDeviceInfo",
    "content": {
      "ip": "string",
      "mac": "string",
      "systemVersion": "string",
      "kernelVersion": "string",
      "appVersion": "string",
      "motherboard": "XZ358"
    },
    "deviceID": "DAFADC0A9311",
    "time": 1621425835000,
    "sender": "android"
  }
  

  This example has been generated automatically.

• #3uploadScreenCap上传屏幕截图文件

  上传屏幕截图文件后，把结果通知给服务器

  Payload

  object

  event

  string

  Allowed values:
  • "uploadScreenCap"

  content

  object

  code

  number

  下载结果：

  • 0 上传成功
  • 其他均为失败

  Additional properties are allowed.

  deviceID

  string

  uid: deviceID

  设备的唯一ID，Android设备为Mac地址

  Examples values:
  • "DAFADC0A9311"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: androidSender

  消息来自Android设备

  Allowed values:
  • "android"

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "uploadScreenCap",
    "content": {
      "code": 0
    },
    "deviceID": "DAFADC0A9311",
    "time": 1621425835000,
    "sender": "android"
  }
  

  This example has been generated automatically.

• #4uploadScreenRecord上传屏幕录屏文件

  上传屏幕录屏文件后，把结果通知给服务器

  Payload

  object

  event

  string

  Allowed values:
  • "uploadScreenRecord"

  content

  object

  code

  number

  下载结果：

  • 0 上传成功
  • 其他均为失败

  Additional properties are allowed.

  deviceID

  string

  uid: deviceID

  设备的唯一ID，Android设备为Mac地址

  Examples values:
  • "DAFADC0A9311"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: androidSender

  消息来自Android设备

  Allowed values:
  • "android"

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "uploadScreenRecord",
    "content": {
      "code": 0
    },
    "deviceID": "DAFADC0A9311",
    "time": 1621425835000,
    "sender": "android"
  }
  

  This example has been generated automatically.

• #5uploadLog上传日志文件

  上传日志文件后，把结果通知给服务器

  Payload

  object

  event

  string

  Allowed values:
  • "uploadLog"

  deviceID

  string

  uid: deviceID

  设备的唯一ID，Android设备为Mac地址

  Examples values:
  • "DAFADC0A9311"

  time

  number

  uid: time

  单位毫秒，消息时间戳

  Examples values:
  • 1621425835000

  sender

  string

  uid: androidSender

  消息来自Android设备

  Allowed values:
  • "android"

  Additional properties are allowed.

  Examples

  Payload

  {
    "event": "uploadLog",
    "deviceID": "DAFADC0A9311",
    "time": 1621425835000,
    "sender": "android"
  }
  

  This example has been generated automatically.