# JT808 WebApi服务 基地址：127.0.0.1:828/jt808api/ > 注意url格式 数据格式：只支持Json格式 默认端口：828 ## 1.统一下发设备消息服务 [基于Tcp统一下发设备消息服务](#tcp_send) [基于Udp统一下发设备消息服务](#udp_send) ## 2.管理会话服务 [基于Tcp管理会话服务](#tcp_session) [基于Udp管理会话服务](#udp_session) ## 3.转发地址过滤服务 [基于Tcp转发地址过滤服务](#tcp_transmit) ## 4.消息包计数服务（次日清零） [基于Tcp消息包计数服务](#tcp_counter) [基于Udp消息包计数服务](#udp_counter) ## 5.流量统计服务（次日清零） [基于Tcp流量统计服务](#tcp_traffic) [基于Udp流量统计服务](#udp_traffic) ## 6.系统性能数据采集服务 [获取当前系统进程使用率](#system_collect) ## 接口请求对照表 ### 基于Tcp接口请求 |请求Url|请求方式|说明| |:------|:------|:------| | 127.0.0.1:828/jt808api/Tcp/UnificationSend| POST| 基于Tcp统一下发设备消息服务| | 127.0.0.1:828/jt808api/Tcp/Session/GetAll| GET| 基于Tcp管理会话服务-获取会话集合| | 127.0.0.1:828/jt808api/Tcp/Session/RemoveByTerminalPhoneNo| POST| 基于Tcp管理会话服务-通过设备终端号移除对应会话| | 127.0.0.1:828/jt808api/Tcp/Transmit/Add| POST| 基于Tcp转发地址过滤服务-添加转发过滤地址| | 127.0.0.1:828/jt808api/Tcp/Transmit/Remove| POST| 基于Tcp转发地址过滤服务-删除转发过滤地址| | 127.0.0.1:828/jt808api/Tcp/Transmit/GetAll| GET| 基于Tcp转发地址过滤服务-获取转发过滤地址信息集合| | 127.0.0.1:828/jt808api/Tcp/GetAtomicCounter| GET| 基于Tcp消息包计数服务| | 127.0.0.1:828/jt808api/Tcp/Traffic/Get| GET| 基于Tcp流量统计服务| ### 基于Udp接口请求 |请求Url|请求方式|说明| |:------|:------|:------| | 127.0.0.1:828/jt808api/Udp/UnificationSend| POST| 基于Udp统一下发设备消息服务| | 127.0.0.1:828/jt808api/Udp/Session/GetAll| GET| 基于Udp管理会话服务-获取会话集合| | 127.0.0.1:828/jt808api/Udp/Session/RemoveByTerminalPhoneNo| POST| 基于Udp管理会话服务-通过设备终端号移除对应会话| | 127.0.0.1:828/jt808api/Udp/GetAtomicCounter| GET| 基于Udp消息包计数服务| | 127.0.0.1:828/jt808api/Udp/Traffic/Get| GET| 基于Udp流量统计服务| ### 公共接口请求 |请求Url|请求方式|说明| |:------|:------|:------| | 127.0.0.1:828/jt808api/SystemCollect/Get| GET| 获取当前系统进程使用情况| ### 统一对象返回 JT808ResultDto\ |属性|数据类型|参数说明| |:------:|:------:|:------| | Message| string| 消息描述| | Code| int| 状态码| | Data| T（泛型）| 数据| 返回Code[状态码]说明： |状态码|说明| |:------:|:------:| | 200 | 返回成功 | | 201 | 内容为空 | | 404 | 没有该服务 | | 500 | 服务内部错误 | ### 基于Tcp统一下发设备消息服务 请求地址：Tcp/UnificationSend 请求方式：POST 请求参数： |属性|数据类型|参数说明| |------|:------:|:------| | TerminalPhoneNo| string| 设备终端号| | Data| byte[]| JT808 byte[]数组| 返回数据： |属性|数据类型|参数说明| |:------:|:------:|:------| | Data| bool| 是否成功| 返回结果： ``` result1 { "Message":"", "Code":200, "Data":true } ``` ### 基于Udp统一下发设备消息服务 请求地址：Udp/UnificationSend 请求方式：POST 请求参数： |属性|数据类型|参数说明| |------|:------:|:------| | TerminalPhoneNo| string| 设备终端号| | Data| byte[]| JT808 byte[]数组| 返回数据： |属性|数据类型|参数说明| |:------:|:------:|:------| | Data| bool| 是否成功| 返回结果： ``` result1 { "Message":"", "Code":200, "Data":true } ``` ### 基于Tcp管理会话服务 #### 统一会话信息对象返回 JT808TcpSessionInfoDto |属性|数据类型|参数说明| |------|------|------| | LastActiveTime| DateTime| 最后上线时间| | StartTime| DateTime| 上线时间| | TerminalPhoneNo|string| 终端手机号| | RemoteAddressIP| string| 远程ip地址| #### 1.获取会话集合 请求地址：Tcp/Session/GetAll 请求方式：GET 返回数据： |属性|数据类型|参数说明| |:------:|:------:|:------| | Data| List\ | 实际会话信息集合 | 返回结果： ``` session1 { "Message":"", "Code":200, "Data":[ { "LastActiveTime":"2018-11-27 20:00:00", "StartTime":"2018-11-25 20:00:00", "TerminalPhoneNo":"123456789012", "RemoteAddressIP":"127.0.0.1:11808" },{ "LastActiveTime":"2018-11-27 20:00:00", "StartTime":"2018-11-25 20:00:00", "TerminalPhoneNo":"123456789013", "RemoteAddressIP":"127.0.0.1:11808" } ] } ``` #### 2.通过设备终端号移除对应会话 请求地址：Tcp/Session/RemoveByTerminalPhoneNo 请求方式：POST 请求参数： |属性|数据类型|参数说明| |:------:|:------:|:------| | terminalPhoneNo| string| 设备终端号| 返回数据： |属性|数据类型|参数说明| |:------:|:------:|:------| | Data| bool | 是否成功 返回结果： ``` session3 { "Message":"", "Code":200, "Data":true } ``` ### 基于Udp管理会话服务 #### 统一会话信息对象返回 JT808UdpSessionInfoDto |属性|数据类型|参数说明| |------|------|------| | LastActiveTime| DateTime| 最后上线时间| | StartTime| DateTime| 上线时间| | TerminalPhoneNo|string| 终端手机号| | RemoteAddressIP| string| 远程ip地址| #### 1.获取会话集合 请求地址：Udp/Session/GetAll 请求方式：GET 返回数据： |属性|数据类型|参数说明| |:------:|:------:|:------| | Data| List\ | 实际会话信息集合 | 返回结果： ``` session1 { "Message":"", "Code":200, "Data":[ { "LastActiveTime":"2018-11-27 20:00:00", "StartTime":"2018-11-25 20:00:00", "TerminalPhoneNo":"123456789012", "RemoteAddressIP":"127.0.0.1:11808" },{ "LastActiveTime":"2018-11-27 20:00:00", "StartTime":"2018-11-25 20:00:00", "TerminalPhoneNo":"123456789013", "RemoteAddressIP":"127.0.0.1:11808" } ] } ``` #### 2.通过设备终端号移除对应会话 请求地址：Udp/Session/RemoveByTerminalPhoneNo 请求方式：POST 请求参数： |属性|数据类型|参数说明| |:------:|:------:|:------| | terminalPhoneNo| string| 设备终端号| 返回数据： |属性|数据类型|参数说明| |:------:|:------:|:------| | Data| bool | 是否成功 返回结果： ``` session3 { "Message":"", "Code":200, "Data":true } ``` ### 基于Tcp转发地址过滤服务 #### 1.添加转发过滤地址 请求地址：Tcp/Transmit/Add 请求方式：POST 请求参数： |属性|数据类型|参数说明| |:------:|:------:|:------| | Host| string| ip地址| | Port| int| 端口号| 返回数据： |属性|数据类型|参数说明| |:------:|:------:|:------| | Data| bool | 是否成功 返回结果： ``` tr1 { "Message":"", "Code":200, "Data":true } ``` #### 2.删除转发过滤地址（不能删除在网关服务器配置文件配的地址） 请求地址：Tcp/Transmit/Remove 请求方式：POST 请求参数： |属性|数据类型|参数说明| |:------:|:------:|:------| | Host| string| ip地址| 返回数据： |属性|数据类型|参数说明| |:------:|:------:|:------| | Data| bool | 是否成功| 返回结果： ``` tr2 { "Message":"", "Code":200, "Data":true } ``` #### 3.获取转发过滤地址信息集合 请求地址：Tcp/Transmit/GetAll 请求方式：GET 返回数据： |属性|数据类型|参数说明| |------|:------:|:------| | Data| List\ | 远程ip地址(不加端口号)| 返回结果： ``` tr3 { "Message":"", "Code":200, "Data":[ "127.0.0.1" ] } ``` ### 基于Tcp消息包计数服务 请求地址：Tcp/GetAtomicCounter 请求方式：GET 返回数据： |属性|数据类型|参数说明| |------|:------:|:------| | MsgSuccessCount| long| 消息包成功数| | MsgFailCount| long| 消息包失败数| 返回结果： ``` counter { "Message":"", "Code":200, "Data":{ "MsgSuccessCount":10000, "MsgFailCount":0 } } ``` ### 基于Udp消息包计数服务 请求地址：Udp/GetAtomicCounter 请求方式：GET 返回数据： |属性|数据类型|参数说明| |------|:------:|:------| | MsgSuccessCount| long| 消息包成功数| | MsgFailCount| long| 消息包失败数| 返回结果： ``` counter { "Message":"", "Code":200, "Data":{ "MsgSuccessCount":1000, "MsgFailCount":0 } } ``` ### 基于Tcp流量统计服务 请求地址：Tcp/Traffic/Get 请求方式：GET 返回数据： |属性|数据类型|参数说明| |------|:------:|:------| | TotalReceiveSize| double| 总接收大小(单位KB)| | TotalSendSize| double| 总发送大小(单位KB)| 返回结果： ``` traffic1 { "Message":"", "Code":200, "Data":{ "TotalReceiveSize":0.0478515625, "TotalSendSize":0.01953125 } } ``` ### 基于Udp流量统计服务 请求地址：Udp/Traffic/Get 请求方式：GET 返回数据： |属性|数据类型|参数说明| |------|:------:|:------| | TotalReceiveSize| double| 总接收大小(单位KB)| | TotalSendSize| double| 总发送大小(单位KB)| 返回结果： ``` traffic2 { "Message":"", "Code":200, "Data":{ "TotalReceiveSize":0.0478515625, "TotalSendSize":0.01953125 } } ``` ### 系统性能数据采集服务 请求地址：SystemCollect/Get 请求方式：GET 返回数据： |属性|数据类型|参数说明| |------|:------:|:------| | ProcessId| int| 进程Id| | WorkingSet64| double| 进程分配内存(单位MB)| | PeakWorkingSet64| double| 进程分配内存峰值(单位MB)| | PrivateMemorySize64| double| 进程分配私有内存(单位MB)| | CPUTotalProcessorTime| TimeSpan|进程执行CPU总处理时间| 返回结果： ``` sc { "Message":"", "Code":200, "Data":{ "ProcessId":101412, "WorkingSet64":73.0625, "PeakWorkingSet64":73.0625, "PrivateMemorySize64":134.6796875, "CPUTotalProcessorTime":"00:00:14.5625000" } } ```