列出会话列表

接口地址：

  • /api/chat/channel/list

  • /api/chat/channellist

HTTP请求方式

  • GET

请求参数

  • 无或见实现

响应代码

  • 共通响应

示例:

curl -X GET "$BASE_URL/api/chat/channel/list"

响应示例：

  • JSON:

    {
  "data": { "list": [] },
  "code": 0,
  "message": "OK"
}

创建会话

接口地址：

  • /api/chat/channel/create

HTTP请求方式

  • POST

请求参数

  • name (form, required): 频道名称

  • public (form, required): 是否公开，true/false

响应代码

  • 共通响应

示例:

curl -X POST "$BASE_URL/api/chat/channel/create" -d "name=频道名&public=true"

响应示例：

  • JSON:

    {
  "code": 0,
  "message": "OK",
  "data": {}
}

获取或创建会话

接口地址：

  • /api/chat/channel/getorcreate

HTTP请求方式

  • POST

请求参数

  • 见实现（根据成员获取或创建私聊频道）

响应代码

  • 共通响应

获取会话 ID

接口地址：

  • /api/chat/channel/id

HTTP请求方式

  • GET

请求参数

  • 见实现

响应代码

  • 共通响应

获取会话详情

接口地址：

  • /api/chat/channel/detail/:id

HTTP请求方式

  • GET

请求参数

  • id (path): 频道 ID

响应代码

  • 共通响应

删除会话

接口地址：

  • /api/chat/channel/delete

HTTP请求方式

  • POST

请求参数

  • id (form, required): 频道 ID

响应代码

  • 共通响应

退出会话

接口地址：

  • /api/chat/channel/leave

HTTP请求方式

  • POST

请求参数

  • id (form, required): 频道 ID

响应代码

  • 共通响应

加入会话

接口地址：

  • /api/chat/channel/join

HTTP请求方式

  • POST

请求参数

  • id (form, required): 频道 ID

响应代码

  • 共通响应

添加会话成员

接口地址：

  • /api/chat/channel/addmember

HTTP请求方式

  • POST

请求参数

  • id (form, required): 频道 ID

  • 成员相关参数见实现

响应代码

  • 共通响应

移除会话成员

接口地址：

  • /api/chat/channel/removemember

HTTP请求方式

  • POST

请求参数

  • id (form, required): 频道 ID

  • 成员相关参数见实现

响应代码

  • 共通响应

列出聊天用户

接口地址：

  • /api/chat/userlist

HTTP请求方式

  • GET

请求参数

  • domain (path/query): 域名

响应代码

  • 共通响应

列出消息

接口地址：

  • /api/chat/message/list

HTTP请求方式

  • GET

请求参数

  • 见实现

响应代码

  • 共通响应

创建消息

接口地址：

  • /api/chat/message/create

HTTP请求方式

  • POST

请求参数

  • id (form, required): 频道 ID 或会话标识

  • content (form, required): 消息内容

  • msg_type (form, optional): 消息类型

响应代码

  • 共通响应

删除消息

接口地址：

  • /api/chat/message/delete

HTTP请求方式

  • POST

请求参数

  • 见实现

响应代码

  • 共通响应

搜索消息

接口地址：

  • /api/chat/message/search

HTTP请求方式

  • POST

请求参数

  • 见实现

响应代码

  • 共通响应

消息命令

接口地址：

  • /api/chat/message/command

HTTP请求方式

  • POST

请求参数

  • 见实现

响应代码

  • 共通响应

消息流

接口地址：

  • /api/chat/message/timeline

HTTP请求方式

  • GET

请求参数

  • 见实现

响应代码

  • 共通响应

聊天文件下载

接口地址：

  • /chatfile/download/:id

HTTP请求方式

  • GET

请求参数

  • id (path): 文件 ID

响应代码

  • 重定向到下载地址或流

v1 获取 API Key

接口地址：

  • /api/v1/fetch_api_key

HTTP请求方式

  • POST

请求参数

  • user (form): 用户名

  • password (form): 密码

  • 见实现

响应代码

  • 共通响应

v1 注册

接口地址：

  • /api/v1/register

HTTP请求方式

  • POST

请求参数

  • 见实现

响应代码

  • 共通响应

v1 事件

接口地址：

  • /api/v1/events

HTTP请求方式

  • GET

请求参数

  • 见实现（SSE 等）

响应代码

  • 共通响应

v1 获取消息

接口地址：

  • /api/v1/messages

HTTP请求方式

  • GET

请求参数

  • 见实现

响应代码

  • 共通响应

v1 发送消息

接口地址：

  • /api/v1/messages

HTTP请求方式

  • POST

请求参数

  • 见实现

响应代码

  • 共通响应

v1 消息详情

接口地址：

  • /api/v1/messages/:id

HTTP请求方式

  • GET

请求参数

  • id (path): 消息 ID

响应代码

  • 共通响应

聊天消息历史

接口地址：

  • /api/chat/messages/history

HTTP请求方式

  • GET

请求参数

  • 见实现

响应代码

  • 共通响应

v1 注册队列

接口地址：

  • /api/v1/register_queue

HTTP请求方式

  • POST

请求参数

  • 见实现

响应代码

  • 共通响应

v1 用户上传

接口地址：

  • /api/v1/user_uploads

HTTP请求方式

  • POST

请求参数

  • multipart 上传

响应代码

  • 共通响应

v1 用户在线状态

接口地址：

  • /api/v1/users/me/presence

HTTP请求方式

  • POST

请求参数

  • 见实现

响应代码

  • 共通响应

v1 当前用户

接口地址：

  • /api/v1/users/me

HTTP请求方式

  • GET

请求参数
响应代码

  • 共通响应

v1 服务器设置

接口地址：

  • /api/v1/server_settings

HTTP请求方式

  • POST

请求参数

  • 见实现

响应代码

  • 共通响应