说明
使用教程
连接WSS之后,就可以在相同client_id之间的连接端中共享数据。
发送的消息结构如下:
type (消息类型)
详见下面👇
client_id
您申请的client_id
client_secret
您申请的client_secret(请勿公开)
data (数据)
自定义数据
消息类型详解
消息类型分为三种,分别是执行请求
、查询请求
、广播请求
执行请求,所有请求参数应该包含在
data
字段中。
当前的执行请求有:
init
init请求,通常在连接成功后发送
-
closeClient
用于关闭同client_id的某个连接端的连接。
需要参数:
- 将WS连接端ID放在
data
字段中即可,比如
{"type":"closeClient","client_id":"...","client_secret":"...","data":"1xxxxxxx097xxxxxx"}
-
sendPrivateMsg
用于向指定WS连接端发送私信
需要参数:
- 将WS连接端ID放在
data
字段中的cid
字段中即可,比如
{"type":"sendPrivateMsg","client_id":"...","client_secret":"...","data":{"cid":"1xxxxxxx097xxxxxx","msg":"xxx"}}
查询请求,服务端会将查询数据发送给连接端,因此为了方便找到查询对应的返回值,您需要指定
flag
字段,服务端发送返回值时将包含该flag字段。
当前的查询请求有:
-
status
查询同client_id在线的连接端ID
无需参数
返回值:
flag
标识
data
查询到的数据(数组)
time
查询时的时间戳
例:{"type":"status","client_id":"...","client_secret":"...","data":{}}
除其余两种请求中的类型外,其他任意类型都会被作为广播请求发送
广播请求会对同client_id的所有连接端发送消息
例:{"type":"message","client_id":"...","client_secret":"...","data":{"msg":"xxx"}}
其他
- 服务端会定时向客户端发送
{"type":"ping"}
来确认存活
- 连接WSS后,
client_id
和client_secret
只需要在第一次发送消息时附带发送,此后同连接发送的消息都无需附带这两个参数,服务端会从session中读取他们。