WebSocket Overview

wss://ws.dev.vocantly.com/ws

const ws = new WebSocket('wss://ws.dev.vocantly.com/ws', [token]);

const ws = new WebSocket('wss://ws.dev.vocantly.com/ws', {
  headers: { 'Authorization': `Bearer ${token}` }
});

interface ClientMessage {
  type: string;              // Message type
  conversation_id?: string;  // Conversation ID (if applicable)
  payload?: any;             // Message payload
}

interface ServerMessage {
  type: string;    // Message type or action
  payload?: any;   // Response payload
  error?: string;  // Error message (if error)
}

{
  "type": "join",
  "conversation_id": "conversation-uuid"
}

{
  "type": "joined",
  "payload": {
    "conversation_id": "conversation-uuid"
  }
}

{
  "type": "leave",
  "conversation_id": "conversation-uuid"
}

{
  "type": "left",
  "payload": {
    "conversation_id": "conversation-uuid"
  }
}

{
  "type": "message",
  "conversation_id": "conversation-uuid",
  "payload": {
    "message_id": "message-uuid",
    "content": "Hello, world!",
    "message_type": "text"
  }
}

{
  "type": "message",
  "conversation_id": "conversation-uuid",
  "payload": {
    "message_id": "message-uuid",
    "sender_id": "user-uuid",
    "sender_type": "sdk",
    "content": "Hello, world!",
    "message_type": "text",
    "sent_at": "2024-01-01T00:00:00Z"
  }
}

{
  "type": "read",
  "conversation_id": "conversation-uuid",
  "message_id": "message-uuid"
}

{
  "type": "typing_start",
  "conversation_id": "conversation-uuid"
}

{
  "type": "typing_stop",
  "conversation_id": "conversation-uuid"
}

{
  "type": "error",
  "error": "conversation_id is required"
}

{
  "type": "typing",
  "conversation_id": "conversation-uuid",
  "payload": {
    "user_id": "user-uuid",
    "status": "typing"
  }
}

{
  "type": "presence",
  "payload": {
    "user_id": "user-uuid",
    "status": "online"
  }
}

// token from your backend
const ws = new WebSocket('wss://ws.dev.vocantly.com/ws', [token]);

ws.onopen = () => {
  console.log('Connected!');
};

ws.send(JSON.stringify({
  type: 'join',
  conversation_id: 'conversation-uuid'
}));

ws.send(JSON.stringify({
  type: 'message',
  conversation_id: 'conversation-uuid',
  payload: {
    message_id: generateUUID(),
    content: 'Hello!',
    message_type: 'text'
  }
}));

ws.onmessage = (event) => {
  const message = JSON.parse(event.data);
  
  if (message.type === 'message') {
    console.log('New message:', message.payload.content);
  }
};

ws.onerror = (error) => {
  console.error('WebSocket error:', error);
};

ws.onclose = (event) => {
  console.log('Connection closed:', event.code, event.reason);
  // Implement reconnection logic
};