sendToUid
向uid绑定的所有在线client_id发送消息
- 此方法需要配合 bindUid 使用
- uid与client_id是一对多的关系,允许多个client_id绑定一个uid
- 如果uid绑定多个client_id,则多个client_id都会收到消息
接口URL
/api/sendToUid
请求方式
POST
请求Header参数
普通模式(Token验证)
默认,服务运行于普通模式,请求携带Header参数:
参数名 | 类型 | 描述 |
---|---|---|
Token | string | 认证Token,即 config.json 文件中的Token |
安全模式(签名验证)
可指定启动参数 -s=true
,将服务运行于安全模式,请求携带Header参数:
参数名 | 类型 | 描述 |
---|---|---|
Timestamp | int | 请求毫秒时间戳 |
Signature | string | 请求签名值签名算法 |
请求Query参数
参数名 | 示例值 | 参数类型 | 是否必填 | 参数描述 |
---|---|---|---|---|
uid | 1 | string | 是 | - |
请求Body参数
text
消息内容为纯文本字符串,服务器不做任何处理,直接透传给客户端。
响应示例
成功
json
{
"code": 0,
"message": "成功"
}
失败
json
{
"code": 118,
"message": "UID不在线或不存在"
}
json
{
"code": 119,
"message": "发送失败,可能是通道已满或连接已关闭"
}