Skip to content

ungroup

解散并销毁某个群组

  1. 解散并销毁群组后,仍然可以调用 joinGroup 再次创建同名的群组
  2. 如果群组内的客户端都下线,该群组也会被自动解散并销毁,无需手动操作

接口URL

/api/ungroup

请求方式

POST

Content-Type

application/json;charset=utf-8

普通模式(Token验证)

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

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

安全模式(签名验证)

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

参数名类型描述
Timestampint请求毫秒时间戳
Signaturestring请求签名值签名算法

请求Body参数

参数名类型是否必填群组名称
groupstring群组名称

请求Body示例

json
{
  "group": "suws"
}

响应示例

成功

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

失败

json
{
  "code": 123,
  "message": "缺少group参数"
}
json
{
  "code": 121,
  "message": "群组不存在"
}