Realtime Features

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

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

import { Vocantly } from '@vocantly/sdk';

const client = new Vocantly({
  wsUrl: 'wss://ws.dev.vocantly.com/ws',
  token // from your backend (POST /apps/:id/tokens)
});

await client.connect();

client.on('connection_state', (state) => {
  switch (state) {
    case 'connecting':
      console.log('Connecting...');
      break;
    case 'connected':
      console.log('Connected!');
      break;
    case 'disconnected':
      console.log('Disconnected');
      break;
    case 'reconnecting':
      console.log('Reconnecting...');
      break;
  }
});

// Using SDK
await client.conversations.join(conversationId);

// WebSocket protocol
ws.send(JSON.stringify({
  type: 'join',
  conversation_id: conversationId
}));

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

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

await client.messages.send({
  conversationId: conversationId,
  content: 'Hello, world!'
});

// Using SDK
client.messages.on('message', (message) => {
  console.log('Received:', message.content);
  console.log('From:', message.sender_id);
  console.log('Conversation:', message.conversation_id);
});

// WebSocket protocol
ws.on('message', (data) => {
  const message = JSON.parse(data);
  if (message.type === 'message') {
    console.log('Received:', message.payload.content);
  }
});

client.on('presence', (event) => {
  console.log('User presence changed:', event.user_id, event.state);
  // event.state is 'online' or 'offline'
});

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

// Using SDK
await client.typing.start(conversationId);

// WebSocket protocol
ws.send(JSON.stringify({
  type: 'typing_start',
  conversation_id: conversationId
}));

// Using SDK
await client.typing.stop(conversationId);

// WebSocket protocol
ws.send(JSON.stringify({
  type: 'typing_stop',
  conversation_id: conversationId
}));

client.typing.on('typing', (event) => {
  console.log('User typing:', event.user_id);
  console.log('Conversation:', event.conversation_id);
});

// Using SDK — mark a message read on its conversation
client.conversations.get(conversationId).markRead(messageId);

// WebSocket protocol
ws.send(JSON.stringify({
  type: 'read',
  conversation_id: conversationId,
  payload: {
    message_id: messageId
  }
}));

client.receipts.on('receipt', (receipt) => {
  console.log('Message read:', receipt.message_id);
  console.log('By user:', receipt.user_id);
});

client.on('error', (error) => {
  console.error('WebSocket error:', error);
  // Handle error (reconnect, show to user, etc.)
});

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