sendToAll

发送消息给所有在线客户端，适用于广播场景。

通过可选的参数发送给指定的客户端、排除的客户端、排除的UID。

接口URL

/api/sendToAll

请求方式

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	要发送的消息	是
client_ids	array	发送给指定的客户端	否
exclude_client_ids	array	排除的客户端	否
exclude_uids	array	排除的UID	否

请求Body示例

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

响应示例

成功

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

失败

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

{
  "code": 104,
  "message": "发送失败，客户端可能不在线"
}

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

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

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