list chat channel

interface address:

  • /api/chat/channel/list

  • /api/chat/channellist

HTTP request method:

  • GET

request params:

  • None or see the implementation

response code:

  • common response

example:

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

response example：

  • JSON:

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

create chat channel

interface address:

  • /api/chat/channel/create

HTTP request method:

  • POST

request params:

  • name (form, required): channel name

  • public (form, required): whether it is public, true/false

response code:

  • common response

example:

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

response example：

  • JSON:

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

get or create chat channel

interface address:

  • /api/chat/channel/getorcreate

HTTP request method:

  • POST

request params:

  • See the implementation (get or create a private chat channel based on the members)

response code:

  • common response

get chat channel id

interface address:

  • /api/chat/channel/id

HTTP request method:

  • GET

request params:

  • See the implementation

response code:

  • common response

get chat channel detail

interface address:

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

HTTP request method:

  • GET

request params:

  • id (path): channel ID

response code:

  • common response

delete chat channel

interface address:

  • /api/chat/channel/delete

HTTP request method:

  • POST

request params:

  • id (form, required): channel ID

response code:

  • common response

leave chat channel

interface address:

  • /api/chat/channel/leave

HTTP request method:

  • POST

request params:

  • id (form, required): channel ID

response code:

  • common response

join chat channel

interface address:

  • /api/chat/channel/join

HTTP request method:

  • POST

request params:

  • id (form, required): channel ID

response code:

  • common response

add channel member

interface address:

  • /api/chat/channel/addmember

HTTP request method:

  • POST

request params:

  • id (form, required): channel ID

  • See the implementation for member-related parameters

response code:

  • common response

remove channel member

interface address:

  • /api/chat/channel/removemember

HTTP request method:

  • POST

request params:

  • id (form, required): channel ID

  • See the implementation for member-related parameters

response code:

  • common response

get chat user list

interface address:

  • /api/chat/userlist

HTTP request method:

  • GET

request params:

  • domain (path/query): domain

response code:

  • common response

chat message list

interface address:

  • /api/chat/message/list

HTTP request method:

  • GET

request params:

  • See the implementation

response code:

  • common response

create chat message

interface address:

  • /api/chat/message/create

HTTP request method:

  • POST

request params:

  • id (form, required): channel ID or session identifier

  • content (form, required): message content

  • msg_type (form, optional): message type

response code:

  • common response

delete chat message

interface address:

  • /api/chat/message/delete

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

search chat message

interface address:

  • /api/chat/message/search

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

chat message command

interface address:

  • /api/chat/message/command

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

chat message timeline

interface address:

  • /api/chat/message/timeline

HTTP request method:

  • GET

request params:

  • See the implementation

response code:

  • common response

chat file download

interface address:

  • /chatfile/download/:id

HTTP request method:

  • GET

request params:

  • id (path): file ID

response code:

  • Redirects to the download URL or stream

v1 fetch api key

interface address:

  • /api/v1/fetch_api_key

HTTP request method:

  • POST

request params:

  • user (form): username

  • password (form): password

  • See the implementation

response code:

  • common response

v1 register

interface address:

  • /api/v1/register

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

v1 events

interface address:

  • /api/v1/events

HTTP request method:

  • GET

request params:

  • See the implementation (e.g. SSE)

response code:

  • common response

v1 get messages

interface address:

  • /api/v1/messages

HTTP request method:

  • GET

request params:

  • See the implementation

response code:

  • common response

v1 send messages

interface address:

  • /api/v1/messages

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

v1 message detail

interface address:

  • /api/v1/messages/:id

HTTP request method:

  • GET

request params:

  • id (path): message ID

response code:

  • common response

chat messages history

interface address:

  • /api/chat/messages/history

HTTP request method:

  • GET

request params:

  • See the implementation

response code:

  • common response

v1 register queue

interface address:

  • /api/v1/register_queue

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

v1 user uploads

interface address:

  • /api/v1/user_uploads

HTTP request method:

  • POST

request params:

  • multipart upload

response code:

  • common response

v1 users me presence

interface address:

  • /api/v1/users/me/presence

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response

v1 users me

interface address:

  • /api/v1/users/me

HTTP request method:

  • GET

request params:
response code:

  • common response

v1 server settings

interface address:

  • /api/v1/server_settings

HTTP request method:

  • POST

request params:

  • See the implementation

response code:

  • common response