调用该接口设置业务事件消息推送间隔。
路径 | /vision/customer/bizevent/config/set |
版本号 | 1.0.3 |
协议 | HTTPS |
请求方法 | POST |
是否需要用户身份鉴权 | 可选 |
超时时间 | 3000 |
请求参数
名称 | 类型 | 是否必选 | 示例值 | 描述 |
---|---|---|---|---|
iotId | String | 是 | bZGD54swRgqo****FkEs000101 | 设备ID,生活物联网平台为设备颁发的ID,设备的唯一标识符。 |
eventType | Int | 是 | 1 | 业务事件类型。目前仅支持侦测告警这类业务事件的设置;1为侦测告警。 |
alarmType | Int | 否 | 1 | 告警类型。业务事件类型为1(表示侦测告警事件)时,具体的告警枚举值:1移动侦测;2声音侦测;3人形侦测。 |
eventInterval | Int | 否 | 120 | 业务事件消息推送间隔。单位秒,默认120。 |
timeSection | String | 否 | [{\"beginTime\": 28800,\"endTime\": 79200,\"mode\":1}] | 时间计划的JSON数组字符串。mode:时间计划的模式,1表示每天重复,2表示一周的某几天重复。dayOfWeek:每周的哪天,0表示周日,1-6表示周一到周六。beginTime:开始时间,单位秒,表示时间计划在一天中开始的时间,取值范围0-86400。endTime:结束时间,单位秒,表示时间计划在一天中结束的时间,取值范围0-86400。 |
timeZone | Int | 否 | 8 | UTC时区,取值区间:-11~12。缺省时以服务器时区为准。 |
switchOn | Boolean | 否 | true | 事件推送间隔的开关。true为开关打开,推送事件,所配置的间隔、时间范围等参数生效;false:关闭,不推送事件。 |
返回数据
名称 | 类型 | 示例值 | 描述 |
---|---|---|---|
code | Int | 接口返回码。200表示成功。 |
|
message | String | 调用失败时,返回的出错信息。 |
|
localizedMsg | String | 本地语言的错误消息。 |
示例
请求示例
{
"id": "1509086454180",
"version": "1.0",
"request":{
"apiVer": "1.0.3"
},
"params":{
"iotId": "bZGD54swRgqo****FkEs000101",
"eventType":1,
"alarmType":1,
"eventInterval":120,
"timeSection": "[{\"beginTime\": 28800,\"endTime\": 79200,\"mode\":1}]",
"timeZone":8,
"switchOn":true
}
}
正常返回示例
JSON
格式
{
"id": "4de2c367-c1db-417c-aa15-8c585e595d92",
"code": 200,
"message": null,
"localizedMsg": null,
"data": null
}
异常返回示例
JSON
格式
{
"id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
"code": 403,
"message": "request forbidden.",
"localizedMsg": "请求被禁止",
"data": null
}