WebSocket protocol

This document provides an overview of the WebSocket protocol, which is used for messaging

Message types

  sequenceDiagram


    Client->>Server: Requests
    activate Server
    Server-->>Client: Responses
    deactivate Server

    Server->>Client: Events
    activate Client
    Client-->>Server: Acknowledgments
    deactivate Client
    Client->>Server: Events

1. Client Request

Clients send requests to perform actions like sending, editing, or deleting messages. Each request includes a timestamp and a unique identifier for tracking and synchronization.

Field	Type	Example
type	const	"request"
timestamp	number	1700000000000
id	string	"req001"
payloadType	"new", “edit”, “delete”, ... see requests	"new"
payload	requests	****{"chatId":"User2","message":"Hi from User1!"}

2. Server Response

The server sends an response message in response to client requests,confirming that the requested action has been processed.

Field	Type	Example
type	const	"response"
timestamp	number	1700000000000
id	string	"req001"
payload?	any	{"messageId":5}

3. Server Event and Acknowledgment

Server events are notifications or updates that are pushed to other clients involved in the chat, such as new messages or changes to existing ones. Clients must acknowledge receipt of these events by sending an acknowledgment message back to the server.

Field	Type	Example
type	const	"event"
timestamp	number	1700000000000
id	number	23
eventType	ServerEvent	"online"
payload?	ServerEvent	{"userId": "User2"}

4. Acknowledgment

Clients must send an acknowledgment message back to the server for each event received.

Field	Type	Example
type	const	"ack"
id	string	"23"

Example acknowledgment message:

{
  "type": "ack",
  "id": "23"
}

Message Events and Payloads

Call Events and Payloads

This section describes the different types of call-related events and their associated payloads.

Call Events

• newCall: Indicates a new call has been initiated.
• closeCall: Indicates a call has been closed.

Call Payloads

• CallPayload: Contains information about a call-related message.
• direction: The direction of the call ('incoming' or 'outgoing').
• status: (optional) The status of the call ('missed' or 'received').

• callType: The type of call ('video' or 'audio').

• CallStoredPayload: Contains detailed information about a stored call.

• callId: The unique identifier for the call.
• caller: The identifier of the caller.
• participants: (optional) List of participant identifiers.
• callType: The type of call ('video' or 'audio').
• callDuration: The duration of the call in seconds.

This section describes the different types of message-related events and their associated payloads.

Message Events

• new: Indicates a new message has been sent.
• edit: Indicates a message has been edited.
• delete: Indicates a message has been deleted.
• call: Indicates a call-related message.

Message Payloads

• EditPayload: Contains information about the original message being edited.
• originalMessageId: The ID of the original message.

• originalClientMessageId: The client-generated ID of the original message.

• CallPayload: Contains information about a call-related message.

• direction: The direction of the call ('incoming' or 'outgoing').
• status: (optional) The status of the call ('missed' or 'received').

• callType: The type of call ('video' or 'audio').

• CallStoredPayload: Contains detailed information about a stored call.

• callId: The unique identifier for the call.
• caller: The identifier of the caller.
• participants: (optional) List of participant identifiers.
• callType: The type of call ('video' or 'audio').

• callDuration: The duration of the call in seconds.

• DeletionPayload: Contains information about the message being deleted.

• originalMessageId: The ID of the original message.
• originalClientMessageId: The client-generated ID of the original message.

jsons

sequenceDiagram
    participant User1
    participant Server
    participant ****




    Note over User1,User2: "typing"
    User1->>Server: client event 'typing', chatId User2
    activate Server

    Server->>User2: server event 'typing', chatId User1
    deactivate Server

    Note over User1,User2: message sending
    User1->>Server: Sends message to User2
    activate Server
    Note over User1,Server: request 'new'
    Server->>User1: messageId: 125
    Note over  Server,User1: response to 'new' request
    Server->>User2: server event 'new' (messageId: 125)
    User2--)Server: Ack for 'new' event
    deactivate Server
    Note over User1,User2: "delivering"

    User2->>Server: Message 125 delivered
    activate Server
    Note over  User2,Server: request 'dlvrd'
    Server->>User2: 🫡
    Note over  Server,User2: response to 'dlvrd'
    Server->>User1: Event that message has been delivered
    Note over  Server,User1: server event 'dlvrd'
    User1->>Server: Ack for dlvrd event


    User2->>Server: Message read (messageId: 125)
    Note over User2,Server: request 'read'
    Server->>User2: 🫡
    Note over  Server,User2: response

    Server--)User1: Notification that message has been read
    Note over  Server,User1: server event 'read'
    User1->>Server: Ack for read event


    User1->>Server: User1 requests deletion of a message sent to User2 (id: 2)
    Note over User1,Server: request

    Server->>User1: Accept deletion
    Note over Server,User1: response
    Server--)User2: Notification that a message from User1 has been deleted
    Note over  Server,User2: event
    User2->>Server: Ack for message deleted event