美文网首页
websocket 公用服务器 协议自定义数据结构及字段注释

websocket 公用服务器 协议自定义数据结构及字段注释

作者: 镜花水岳 | 来源:发表于2020-04-22 13:47 被阅读0次

本文采用 Json数据格式
目前由登录,心跳,数据透传3个接口组成
登录:
'{"companyID":"0","stateCode":"10001"}'
注释:companyID:为身份编号:服务器根据此字段将连接对象分组
            stateCode :操作编号,登录固定为10001 
返回数据:
'{"channelNumber":"1""stateCode":"10001","serialNumber":"1234","msg":"登录成功","dataType":"0","data":"XXXX"}'
注释:channelNumber:服务器分配的唯一身份码,断开后即失效
            stateCode:操作编号,登录固定为10001 
            serialNumber:操作流水号
            msg:操作提示
            dataType: 0 没有数据 1 数据是字典类型 2 数据是数组类型
            data:透传数据 格式自定义

心跳:
'{"companyID":"0","channelNumber":"1","stateCode":"10002"}'
注释:  companyID:为身份编号:服务器根据此字段将连接对象分组
           channelNumber:服务器分配的唯一身份码,断开后即失效
           stateCode :操作编号,心跳固定为10002
返回数据:
'{"channelNumber":"1""stateCode":"10002","serialNumber":"1234","msg":"登录成功","dataType":"0","data":"XXXX"}'
注释:格式同上 修改对应参数即可

数据透传:
'{"channelNumber":"1","stateCode":"99999","serialNumber":"1234","msg":"数据透传","dataType":"1","data":{}}'
注释:channelNumber:服务器分配的唯一身份码,断开后即失效
           stateCode:操作编号,透传时自定义
           serialNumber:操作流水号
           msg:操作提示
           dataType: 0 没有数据 1 数据是字典类型  2 数据是数组类型
           data:透传数据 格式自定义

透传示例:
'{"channelNumber":"1","stateCode":"99999","serialNumber":"1234","msg":"数据透传","dataType":"1","data":{"msgLevel":"1","msgType":"1","pageNumber":"1","title":"1","content":"1","imgUrl":"1","time":"1"}}'
 注释: msgLevel :1-9 越高越重要
             msgType  : 1 通知类型信息 2 操作类型信息 3 预警类型信息
             pageNumber : web页面上对应的功能页面编码
             title         : 本次消息的标题
             content   : 本次消息的文本
             imgUrl     : 本次消息的图片
             time         : 本次消息的时间

相关文章

网友评论

      本文标题:websocket 公用服务器 协议自定义数据结构及字段注释

      本文链接:https://www.haomeiwen.com/subject/hsrbihtx.html