leaveGroup
将指定的client_id从某个群组中移除
如果client_id下线,会自动将client_id从所有群组中移除,无需手动操作
接口URL
/api/leaveGroup
请求方式
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示例
json
{
"client_id": "b8cf8629-b9e1-4ef8-b08d-4b186acdfe32",
"group": "suws"
}
响应示例
成功
json
{
"code": 0,
"message": "成功"
}
失败
json
{
"code": 123,
"message": "缺少group参数"
}
json
{
"code": 101,
"message": "缺少client_id参数"
}
json
{
"code": 121,
"message": "群组不存在"
}
json
{
"code": 122,
"message": "客户端不在群组中"
}