Skip to content

推送配置

4.1 查询定时推送频率

查询定时推送的频率,包括实时数据推送频率、设备状态推送频率。

定时推送只会推送实时数据和设备状态。实时数据默认 30 分钟推送一次,设备状态默认 10 分钟推送一次。告警状态仅在告警变换时才会触发一次。

方法名(method): queryScheduleConfig

请求示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "queryScheduleConfig",
  "data": {}
}

请求参数:

响应示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "queryScheduleConfig",
  "data": {
    "code": 200,
    "message": "success",
    "data": {
      "dataPushPeriod": 30,
      "onlineStatusPushPeriod": 10,
      "dataPushStatus": 0,
      "statusPushStstus": 0
    },
    "timestamp": 1764931447717
  }
}

响应参数:

参数数据类型示例描述
dataPushPeriodInteger30推送频率周期,单位分钟
onlineStatusPushPeriodInteger10推送频率周期,单位分钟
dataPushStatusInteger00-正常推送,1-停止推送
statusPushStstusInteger00-正常推送,1-停止推送

4.2 配置定时推送频率

方法名(method): configScheduleFrequency

请求示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "configScheduleFrequency",
  "data": {
    "datePushPeriod": 30,
    "onlineStatusPushPeriod": 10
  }
}

请求参数:

参数数据类型示例必填描述
datePushPeriodInteger30数据推送频率周期,单位分钟
onlineStatusPushPeriodInteger30在线状态推送频率周期,单位分钟

可以只配置一个参数,例如 {"onlineStatusPushPeriod": 10} 或者 {"datePushPeriod": 10}

响应示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "configScheduleFrequency",
  "data": {
    "code": 200,
    "message": "success",
    "data": null,
    "timestamp": 1732694400000
  }
}

4.3 开启/停止推送(全局推送)

这个是全局推送的开启或者关闭。

  • 开启后,所有推送正常推送。默认是推送,配置推送地址之后默认开启推送。
  • 关闭后,所有类型的推送,还有定时的所有推送,都会停止推送。

方法名(method): setPushStatus

请求示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "setPushStatus",
  "data": {
    "pushStatus": 0
  }
}

请求参数:

参数数据类型示例必填描述
pushStatusInteger00-正常推送,1-停止推送

响应示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "setPushStatus",
  "data": {
    "code": 200,
    "message": "success",
    "data": null,
    "timestamp": 1732694400000
  }
}

4.4 获取推送状态

获取全局推送和定时推送的开关。

方法名(method): getScheduleStatus

请求示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "getScheduleStatus",
  "data": {}
}

请求参数:

响应示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "getScheduleStatus",
  "data": {
    "code": 200,
    "message": "success",
    "data": {
      "pushStatus": 0,
      "datePushStatus": 0,
      "onlineStatusPushStatus": 0
    },
    "timestamp": 1732694400000
  }
}

响应参数:

参数数据类型示例描述
pushStatusInteger00-正常推送,1-停止推送,默认 0
datePushStatusInteger00-正常推送,1-停止推送,默认 0
onlineStatusPushStatusInteger00-正常推送,1-停止推送,默认 0

4.5 开启/停止定时推送(定时推送)

这个是定时推送的开启或者关闭的控制,但是优先级小于全局推送。因为全局推送包括数据变化推送和定时推送。

说明

  • 默认是开启定时推送
  • 如果全局推送开启了,然后停止了实时数据的定时推送,那么还是会进行数据变化推送
  • 当开启实时数据的定时推送时(默认开启),实时数据会进行变化推送和定时推送
  • 设备状态、实时数据都是同理

方法名(method): setSchedulePushStatus

请求示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "setSchedulePushStatus",
  "data": {
    "datePushStatus": 0,
    "onlineStatusPushStatus": 0
  }
}

请求参数:

参数数据类型示例必填描述
datePushStatusInteger00-正常推送,1-停止推送
onlineStatusPushStatusInteger00-正常推送,1-停止推送

响应示例:

json
{
  "messageId": "uuid-1234-5678-abcd",
  "appKey": "ABC123456",
  "method": "setSchedulePushStatus",
  "data": {
    "datePushStatus": 0,
    "onlineStatusPushStatus": 0
  }
}