joinGroup

将指定client_id加入某个群组

1. 如果群组不存在，则创建该群组
2. client_id与群组是一对多的关系，允许一个client_id加入多个群组，以便于接收不同群组的消息
3. 如果client_id下线，会自动将client_id从所有群组中移除，无需手动 leaveGroup 操作
4. 如果群组内的客户端都下线，该群组也会被自动解散并销毁，无需手动 ungroup 操作

提示

• 加入群组成功后，可以通过 sendToGroup 发送消息给该群组内的所有在线客户端。

接口URL

/api/joinGroup

请求方式

POST

Content-Type

application/json;charset=utf-8

请求Header参数

普通模式（Token验证）

默认，服务运行于普通模式，请求携带Header参数：

参数名	类型	描述
Token	string	认证Token，即 config.json 文件中的Token

安全模式（签名验证）

可指定启动参数 -s=true，将服务运行于安全模式，请求携带Header参数：

参数名	类型	描述
Timestamp	int	请求毫秒时间戳
Signature	string	请求签名值签名算法

请求Body参数

参数名	类型	是否必填	描述
client_id	string	是	客户端ID
group	string	是	群组名称

请求Body示例

{
  "client_id": "cd94421e-7e38-4370-bf82-b1b6ff142db5",
  "group": "suws"
}

响应示例

成功

{
  "code": 0,
  "message": "成功"
}

失败

{
  "code": 123,
  "message": "缺少group参数"
}

{
  "code": 101,
  "message": "缺少client_id参数"
}

{
  "code": 104,
  "message": "客户端不在线或不存在"
}