Commit 890f9b4a by giaogiao

编写对接文档

parent 30c2b3fb
This source diff could not be displayed because it is too large. You can view the blob instead.
# wecloud-im 前端Websocket对接文档 # wecloud-im 前端Websocket对接文档
...@@ -74,7 +74,7 @@ clientId:由后端生成 ...@@ -74,7 +74,7 @@ clientId:由后端生成
## 客户端登陆 ## 客户端连接流程
![wc_im_client连接流程-Page-1](https://tva1.sinaimg.cn/large/008i3skNly1gvbhmdzg3kj60zt0u0juf02.jpg) ![wc_im_client连接流程-Page-1](https://tva1.sinaimg.cn/large/008i3skNly1gvbhmdzg3kj60zt0u0juf02.jpg)
...@@ -299,7 +299,7 @@ websocket是异步的 有可能你很快速的发送了几条消息,服务器响 ...@@ -299,7 +299,7 @@ websocket是异步的 有可能你很快速的发送了几条消息,服务器响
```json ```json
{ {
"cmd":2, "cmd":1,
"code":200, "code":200,
"msg":"成功", "msg":"成功",
"data":{ "data":{
...@@ -321,7 +321,7 @@ websocket是异步的 有可能你很快速的发送了几条消息,服务器响 ...@@ -321,7 +321,7 @@ websocket是异步的 有可能你很快速的发送了几条消息,服务器响
```json ```json
{ {
"cmd":1, "cmd":2,
"code":200, "code":200,
"msg":"成功", "msg":"成功",
"data":{ "data":{
......
# wecloud-RTC音视频客户端信令对接文档 # wecloud-RTC音视频客户端信令对接文档
...@@ -25,14 +25,19 @@ client需要监听频道内 状态更新(房间断开,挂断)、用户状态更 ...@@ -25,14 +25,19 @@ client需要监听频道内 状态更新(房间断开,挂断)、用户状态更
![单人WebRTC发起流程图](https://tva1.sinaimg.cn/large/008i3skNgy1guxhnn6x64j60jr0xgmz302.jpg) ![单人WebRTC发起流程图](https://tva1.sinaimg.cn/large/008i3skNgy1guxhnn6x64j60jr0xgmz302.jpg)
## 指令说明 ## 指令说明
#### **subCmd**子类型 #### **subCmd**子类型指令码
##### 客户端**请求**指令列表: ##### 客户端**请求**指令列表:
**create**:创建频道 **create**:创建频道
**join**: 加入频道 **join**: 加入频道
**SDP**:SDP数据转发
**reject**:拒绝加入频道
**leave**:主动挂断(离开频道)
##### 服务端**响应**指令列表: ##### 服务端**响应**指令列表:
......
...@@ -4,13 +4,13 @@ String appKey = "QNtP3EjtLw26ekt0"; ...@@ -4,13 +4,13 @@ String appKey = "QNtP3EjtLw26ekt0";
String appSecret = "a5e619003868258e0f7c5b5821ea00fb6b2302faf2ab3737"; String appSecret = "a5e619003868258e0f7c5b5821ea00fb6b2302faf2ab3737";
-- --
aaaaa1 clientA1
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJ3ZWIiLCJjbGllbnRJZCI6ImFhYWFhMSIsImlzcyI6IndlY2xvdWRfaW0iLCJhcHBLZXkiOiJRTnRQM0VqdEx3MjZla3QwIiwiZXhwIjoxNjc5MjU0MjAzLCJpYXQiOjE2MjkyNzUxOTUsImp0aSI6IjEwNTM0N2YxOGUyYzQ4MzY4ZmQ2OTZjM2Q5NWZhZWZiIn0.kD7eKKQdxOnE8pKGyvtup-xq-JV6GI2qhd6_oUBRl2A
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJ3ZWIiLCJjbGllbnRJZCI6ImNsaWVudEExIiwiaXNzIjoid2VjbG91ZF9pbSIsImFwcEtleSI6IlFOdFAzRWp0THcyNmVrdDAiLCJleHAiOjE2ODQwMDA2NjIsImlhdCI6MTYzNDAyMTY1NCwianRpIjoiYzBiMDExOWNmYzE5NDk1YjgzYWU5YjQ3ZmFlZmM5ZTMifQ.2d_oQT-KwYmSOVZ7zXiuBTB8zRA4H8UgP2m_cMerGHE
-- --
aaaaa2 aaaaa2
eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJ3ZWIiLCJjbGllbnRJZCI6ImFhYWFhMiIsImlzcyI6IndlY2xvdWRfaW0iLCJhcHBLZXkiOiJRTnRQM0VqdEx3MjZla3QwIiwiZXhwIjoxNjc5MjU0MjQ3LCJpYXQiOjE2MjkyNzUyMzksImp0aSI6IjM5NjUwZjZiMzgwYTRkNjFhNzIxYzFmNzQyMjRhMjA1In0.39hQkadKFIXhXJbIfIvsMcLa5YccQF21kP9Wh13qACY eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJhdWQiOiJ3ZWIiLCJjbGllbnRJZCI6ImFhYWFhMiIsImlzcyI6IndlY2xvdWRfaW0iLCJhcHBLZXkiOiJRTnRQM0VqdEx3MjZla3QwIiwiZXhwIjoxNjg0MDAwNzAwLCJpYXQiOjE2MzQwMjE2OTIsImp0aSI6IjFhY2RhNWEzNGI3NjQwZTA4MDBlMWNiMTRhNTBmMWI5In0.m18ZspfoKDx_RjrBJ07o5CP1nSaLAMEwKmSUvh94ilc
-- --
...@@ -21,7 +21,7 @@ aaaaa3 ...@@ -21,7 +21,7 @@ aaaaa3
## 会话 ## 会话
1邀请2 1邀请2
1427910060675305472 1447818154184151040
--群聊发送文本------- --群聊发送文本-------
{ {
...@@ -29,7 +29,7 @@ aaaaa3 ...@@ -29,7 +29,7 @@ aaaaa3
"cmd":1, "cmd":1,
"data":{ "data":{
"diyAbcd":"aaaa自已定2义字段的值", "diyAbcd":"aaaa自已定2义字段的值",
"toConversation":1427910060675305472, "toConversation":1447818154184151040,
"type":-1, "type":-1,
"text":"发给12312123213这是一123个纯文本消息,发给12312123213这是一123个纯文本消息发给12312123213这是一123个纯文本消息", "text":"发给12312123213这是一123个纯文本消息,发给12312123213这是一123个纯文本消息发给12312123213这是一123个纯文本消息",
"attrs":{ "attrs":{
...@@ -80,7 +80,7 @@ load-blance: ...@@ -80,7 +80,7 @@ load-blance:
## 2021年09月27日17:00:50部署国内IM集成版 ## 2021年09月27日17:00:50部署国内IM集成版
部署1.3 版本 部署1.3 版本
| weikeyun_imapi | 121.37.208.9 | 国内IM集成版 weikeyun_imapi | 121.37.208.9 | 国内IM集成版
docker run -p 6379:6379 -d --restart=always --name redis6 -v $PWD/dockerData/redis6:/data redis:6 --appendonly yes --requirepass "axT8knPN5hAP" docker run -p 6379:6379 -d --restart=always --name redis6 -v $PWD/dockerData/redis6:/data redis:6 --appendonly yes --requirepass "axT8knPN5hAP"
...@@ -124,3 +124,33 @@ client需要监听频道内 状态更新(房间断开 .挂断)、用户状态更 ...@@ -124,3 +124,33 @@ client需要监听频道内 状态更新(房间断开 .挂断)、用户状态更
生成的唯一频道id 生成的唯一频道id
### 维护所有用户当前在线的频道ID
new Map<String,Long> map
map.put("clientA",10001)
map.put("clientB",10001)
map.put("clientC",10002)
map.put("clientD",10003)
redis Key:
user_join_channel = ujc
rcu:clientA:10001
rcu:clientB:10001
rcu:clientC:10002
rcu:clientD:10003
### 维护频道中存在的用户
Map<Long,List<String>> map
new List<String> list
list.add("clientA")
list.add("clientB")
map.put(10001,list)
redis Key:
rtc_channel_users = rcu
key = rcu:10001:clientA
key = rcu:10001:clientB
key = rcu:10002:clientC
key = rcu:10003:clientD
\ No newline at end of file
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment