Skip to content

Online Chat

The /chat endpoint provides a real-time messaging system with support for public and private channels.

GET /v3/chat

Retrieves all messages sent during the last hour. This endpoint does not require any options.

Request Example

GET /v3/chat

Response

json
[
    {
      "username": "User1",
      "message": "Hi!",
      "timestamp": "2025-01-21T08:27:11.068Z"
    },
    {
      "username": "User3",
      "message": "How are you?",
      "timestamp": "2025-01-21T08:28:43.070Z"
    },
    {
      "username": "User8",
      "message": "Yeah great, and you?",
      "timestamp": "2025-01-21T08:32:07.215Z"
    }
]

cURL

bash
curl -X GET "https://api.sylvain.pro/v3/chat"

POST /v3/chat

Allows sending a message to the global chat or a private chat.

Parameters

ParameterRequiredDescription
usernameYesThe username of the user who sends the message
messageYesThe message to send
sessionYesThe session ID of the user
tokenNoThe key used to connect to a private chat. If not provided, the message will be sent to the global chat

Request Example

bash
curl -X POST -d "username=User3&message=How are you?&session=abc123&token=41a43360-9874-4c7a-9ca8-eec29e765a0e" "https://api.sylvain.pro/v3/chat"

Response

json
{
  "message": "Message sent successfully"
}

Error Handling

If parameters are missing or invalid, the API will return an error:

Error MessageDescription
Please provide a username (?username={username})The username parameter is missing
Please provide a message (&message={message})The message parameter is missing
Please provide a valid session ID (&session={ID})The session parameter is missing or invalid