Skip to content

全站聊天 API ​

接口地址: /chat

请求方式: POST Content-Type: application/x-www-form-urlencoded

状态: 前端已封装但当前没有页面调用(联机大厅用的是 /oh.php 的房间聊天,见 联机大厅 API)

API 列表 ​

序号接口type 值需要 CSRF
1获取消息列表list否
2发送消息send是
3撤回消息remove是

1. 获取消息列表 ​

bash
curl -X POST https://api.hayfrp.1zyq1.com/chat \
  -H "waf: off" \
  -d "type=list"

2. 发送消息 ​

bash
curl -X POST https://api.hayfrp.1zyq1.com/chat \
  -H "waf: off" \
  -d "type=send&origin=HayFrp Console&csrf=Token值&content=消息内容"
参数说明
origin来源标识,前端固定 HayFrp Console
csrfCSRF Token
content消息内容

3. 撤回消息 ​

bash
curl -X POST https://api.hayfrp.1zyq1.com/chat \
  -H "waf: off" \
  -d "type=remove&csrf=Token值&id=消息ID"

前端封装 ​

typescript
const messages = await api.getChatMessages()
await api.sendChatMessage(csrf, 'Hello World')
await api.removeChatMessage(csrf, 'message_id')

与联机大厅聊天的区别

场景接口作用域
全站聊天/chat全站公共消息(当前未启用入口)
房间聊天/oh.php(getchat / sendchat / clearchat)单个联机房间,需已加入房间

相关页面 ​

基于 MIT 许可证发布