X-Link API 文档-V4.0.0附件信息上传
当触发报警后,终端开始上传附件后,服务器会实时推送附件信息到用户端,主要包含文件数量等信息,UI需要显示上传状态时,可以处理此消息,否则可以忽略
websocket 头字段信息
消息模式: 推送
消息类型: 8004
推送消息定义
| 字段 | 类型 | 说明 |
|---|---|---|
| hdr | object | 消息头,在登录中的表1:websocket消息头 |
| data | object | 附件信息,定义查看当前页表1 |
表1:附件信息
| 字段 | 类型 | 说明 |
|---|---|---|
| alarmCode | string | 报警ID,对应报警信息里面的alarmID |
| deviceNo | string | 终端号 |
| fileInfo | array | 文件信息,定义查看当前页表1 |
表1:文件信息
| 字段 | 类型 | 说明 |
|---|---|---|
| totalSize | integer | 文件大小,字节 |
| fileName | string | 文件名 |
示例
json
{
"hdr": {
"code": 200,
"message": "",
"msgType": 8004,
"reqSN": 1,
"respSN": 0
},
"data": {
"alarmCode":"15552123545556",
"deviceNo":"1300000001",
"fileInfo":[{
"totalSize":102400,
"fileName":"test.jpg"
},{
"totalSize":102400,
"fileName":"test1.mp4"
}]
}
}{
"hdr": {
"code": 200,
"message": "",
"msgType": 8004,
"reqSN": 1,
"respSN": 0
},
"data": {
"alarmCode":"15552123545556",
"deviceNo":"1300000001",
"fileInfo":[{
"totalSize":102400,
"fileName":"test.jpg"
},{
"totalSize":102400,
"fileName":"test1.mp4"
}]
}
}附件上传完成通知
当终端上传完一个附件时,服务器会推送一条完成消息到用户端,如果有多条,则,包括对应的文件信息,用来做状态显示,如果UI无状态显示要求,可以忽略
websocket 头字段信息
消息模式: 推送
消息类型: 8005
推送消息定义
| 字段 | 类型 | 说明 |
|---|---|---|
| hdr | object | 消息头,在登录中的表1:websocket消息头 |
| data | object | 完成的文件信息,定义查看当前页表1 |
表1:完成的文件信息
| 字段 | 类型 | 说明 |
|---|---|---|
| alarmCode | string | 报警ID,对应报警信息里面的alarmID |
| deviceNo | string | 终端号 |
| fileName | string | 文件名 |
示例
json
{
"hdr": {
"code": 200,
"message": "",
"msgType": 8004,
"reqSN": 1,
"respSN": 0
},
"data": {
"alarmCode":"15552123545556",
"deviceNo":"1300000001",
"fileInfo":[{
"totalSize":102400,
"fileName":"test.jpg"
},{
"totalSize":102400,
"fileName":"test1.mp4"
}]
}
}{
"hdr": {
"code": 200,
"message": "",
"msgType": 8004,
"reqSN": 1,
"respSN": 0
},
"data": {
"alarmCode":"15552123545556",
"deviceNo":"1300000001",
"fileInfo":[{
"totalSize":102400,
"fileName":"test.jpg"
},{
"totalSize":102400,
"fileName":"test1.mp4"
}]
}
}