docs: update wg-basic/websocket
This commit is contained in:
parent
0c35150d8d
commit
009de6a662
@ -2,7 +2,7 @@
|
|||||||
title: 7.即时消息
|
title: 7.即时消息
|
||||||
description: 即时消息模块的使用
|
description: 即时消息模块的使用
|
||||||
published: true
|
published: true
|
||||||
date: 2021-10-09T09:57:43.060Z
|
date: 2021-12-07T06:18:53.159Z
|
||||||
tags: wg-basic
|
tags: wg-basic
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2021-09-14T06:25:26.887Z
|
dateCreated: 2021-09-14T06:25:26.887Z
|
||||||
@ -69,8 +69,8 @@ websocket:
|
|||||||
| 2001 | 文本消息 | 发送的字符串内容 |
|
| 2001 | 文本消息 | 发送的字符串内容 |
|
||||||
| 3001 | 通知 | NoticeBody 的 JSONObject 字符串 |
|
| 3001 | 通知 | NoticeBody 的 JSONObject 字符串 |
|
||||||
| 3003 | 带目标的通知,客户端可以根据业务需求动态变更目标(target)内容 | NoticeBody 的 JSONObject 字符串 |
|
| 3003 | 带目标的通知,客户端可以根据业务需求动态变更目标(target)内容 | NoticeBody 的 JSONObject 字符串 |
|
||||||
| 9001 | 消息发送状态 | StatusBody 的 JSONObject 字符串 |
|
| 9001 | 消息发送状态 | MessageSendStatusBody 的 JSONObject 字符串 |
|
||||||
| 9101 | 消息接受状态 | StatusBody 的 JSONObject 字符串 |
|
| 9101 | 消息接受状态 | 自定义的交互内容 |
|
||||||
|
|
||||||
## 3.主体
|
## 3.主体
|
||||||
|
|
||||||
@ -80,7 +80,7 @@ websocket:
|
|||||||
| :-: | :-: | :-: | :-: |
|
| :-: | :-: | :-: | :-: |
|
||||||
| sessionId | 登录获取到的会话ID | String | 否 |
|
| sessionId | 登录获取到的会话ID | String | 否 |
|
||||||
|
|
||||||
**StatusBody**
|
**MessageSendStatusBody**
|
||||||
|
|
||||||
| 属性 | 说明 | 类型 | 是否可空 |
|
| 属性 | 说明 | 类型 | 是否可空 |
|
||||||
| :-: | :-: | :-: | :-: |
|
| :-: | :-: | :-: | :-: |
|
||||||
@ -97,7 +97,7 @@ websocket:
|
|||||||
| target | 目标,需要客户端点击触发效果时使用,可以为约定好的 url、page 等等 | String | 是 |
|
| target | 目标,需要客户端点击触发效果时使用,可以为约定好的 url、page 等等 | String | 是 |
|
||||||
| serviceId | 业务ID | String | 是 |
|
| serviceId | 业务ID | String | 是 |
|
||||||
|
|
||||||
## 4.状态码
|
## 4.消息发送状态码
|
||||||
|
|
||||||
| 编码 | 名称 | 说明 |
|
| 编码 | 名称 | 说明 |
|
||||||
| :-: | :-: | :-: |
|
| :-: | :-: | :-: |
|
||||||
@ -110,6 +110,8 @@ websocket:
|
|||||||
| 405 | FROM_ERROR | 来源错误 |
|
| 405 | FROM_ERROR | 来源错误 |
|
||||||
| 406 | TO_ERROR | 接收人错误 |
|
| 406 | TO_ERROR | 接收人错误 |
|
||||||
| 407 | RECEIVE_ERROR | 接收错误 |
|
| 407 | RECEIVE_ERROR | 接收错误 |
|
||||||
|
| 408 | USER_OFFLINE | 用户离线 |
|
||||||
|
| 408 | CUSTOM_HANDLE_ERROR | 自定义处理异常 |
|
||||||
|
|
||||||
# 自定义处理消息业务
|
# 自定义处理消息业务
|
||||||
|
|
||||||
@ -170,11 +172,16 @@ public enum MessageTypeEnum {
|
|||||||
SEARCH_ONLINE_USER_FRIEND(4002, "查询朋友在线用户,body 为查询用户的 userId"),
|
SEARCH_ONLINE_USER_FRIEND(4002, "查询朋友在线用户,body 为查询用户的 userId"),
|
||||||
SEARCH_COUNT_NEED_TO_DEALT_WITH(4003, "查询全部待办总数"),
|
SEARCH_COUNT_NEED_TO_DEALT_WITH(4003, "查询全部待办总数"),
|
||||||
|
|
||||||
STATUS_SEND(9001, "消息发送状态,body 为 StatusBody 的 JSON 字符串"),
|
WEBRTC_CALL(5001, "webrtc呼叫"),
|
||||||
|
WEBRTC_ANSWER(5002, "webrtc接听"),
|
||||||
|
WEBRTC_REFUSE(5003, "webrtc拒绝"),
|
||||||
|
WEBRTC_JOIN(5004, "webrtc加入"),
|
||||||
|
|
||||||
|
// 消息状态
|
||||||
|
STATUS_SEND(9001, "消息发送状态,body 为 MessageSendStatusBody 的 JSON 字符串"),
|
||||||
STATUS_SEND_ONLINE(9002, "发送在线状态,body 为 在线用户的ID JSONArray 字符串"),
|
STATUS_SEND_ONLINE(9002, "发送在线状态,body 为 在线用户的ID JSONArray 字符串"),
|
||||||
STATUS_SEND_OFFLINE(9003, "发送离线状态,body 为 离线用户的ID JSONArray 字符串"),
|
STATUS_SEND_OFFLINE(9003, "发送离线状态,body 为 离线用户的ID JSONArray 字符串"),
|
||||||
|
STATUS_RECEIVE(9004, "消息接受状态,body 自定义的交互内容");
|
||||||
STATUS_RECEIVE(9101,"消息接受状态,body 为 StatusBody 的 JSON 字符串");
|
|
||||||
|
|
||||||
}
|
}
|
||||||
```
|
```
|
||||||
|
Loading…
Reference in New Issue
Block a user