sendToGroup

向某个群组内所有在线client_id发送消息

接口URL

/api/sendToGroup

请求方式

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参数

参数名	类型	是否必填	描述
data	string	是	将要发送的字符串消息，直接透传到客户端
group	string	是	群组名称
client_ids	array	否	发送给指定的客户端
exclude_client_ids	array	否	排除的客户端
exclude_uids	array	否	排除的UID

请求Body示例

{
  "data": "将要发送的字符串消息，直接透传到客户端",
  "group": "suws",
  "client_ids": [],
  "exclude_client_ids": [],
  "exclude_uids": []
}

响应示例

成功

{
  "code": 0,
  "message": "成功",
  "data": {
    "failure": 0,
    "success": 1
  }
}

失败

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

{
  "code": 124,
  "message": "缺少data参数"
}

{
  "code": 125,
  "message": "群组内客户端为空"
}

{
  "code": 126,
  "message": "发送失败，指定的群组客户端为空"
}

{
  "code": 127,
  "message": "发送失败，排除client_ids后群组客户端为空"
}

{
  "code": 128,
  "message": "发送失败，排除UID后群组客户端为空"
}