MOS Doc

# Base Message

MOS Service消息分为3种类型：

  • Request：Client to Server
  • Response: Server to Client
  • Notify: Server to Client

Request 消息的基本结构：

{
    "method": "moss_xxx_req",
    "parameter": {        
    }, 
    "sequence": 1, 
    "version": 1,   
    "protocol": "3.4.0.0"
}
1
2
3
4
5
6
7
8
  • method: 唯一的消息名
  • parameter: 消息参数，具体内容由消息决定,
  • sequence: 整数，消息序列号，由Client指定，并由Server回传
  • version: 本消息版本号，便于各个消息兼容
  • protocol: 通信协议的版本号

Response 正确消息的基本结构：

{
    "method": "moss_xxx_resp",
    "result": {   
    }, 
    "sequence": 1, 
    "version": 1,
    "protocol": "3.4.0.0"
}
1
2
3
4
5
6
7
8
  • method: 唯一的消息名
  • result: 消息的返回数据，具体内容由消息决定
  • sequence: 整数，消息序列号，由Client指定，并由Server回传
  • version: 本消息版本号，便于各个消息兼容
  • protocol: 通信协议的版本号

Response 错误消息的基本结构：

{
    "method": "moss_xxx_resp",
    "error": {         
        "code": 1,
        "details": "",
        "message": "", 
        "data": {
        }
    }, 
    "sequence": 1,
    "version": 1,
    "protocol": "3.4.0.0"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
  • method: 唯一的消息名+
  • error: 消息的返回数据，具体内容由消息决定
    • code: 错误代码
    • details: 错误详细信息
    • message: 错误描述
    • data: 一般为请求原始数据返回
  • sequence: 整数，消息序列号，由Client指定，并由Server回传
  • version: 本消息版本号，便于各个消息兼容
  • protocol: 通信协议的版本号

Notify 正确消息的基本结构：

{
    "method": "moss_xxx_notify",
    "result": {          
    },
    "sequence": 1,
    "version": 1,
    "protocol": "3.4.0.0"
}
1
2
3
4
5
6
7
8
  • method: 唯一的消息名
  • result: 通知数据，具体内容由消息决定
  • sequence: 整数，消息序列号，由Client指定，并由Server回传
  • version: 本消息版本号，便于各个消息兼容
  • protocol: 通信协议的版本号

Notify 错误消息的基本结构：

{
    "method": "moss_xxx_notify",
    "error": {         
        "code": 1,
        "details": "",
        "message": "", 
        "data": {
        }
    },
    "sequence": 1,
    "version": 1,
    "protocol": "3.4.0.0"
}
1
2
3
4
5
6
7
8
9
10
11
12
13
  • method: 唯一的消息名
  • error: 错误信息，具体内容由消息决定
  • sequence: 整数，消息序列号，由Client指定，并由Server回传
  • version: 本消息版本号，便于各个消息兼容
  • protocol: 通信协议的版本号

← System →