@oxvo/live-assist

@oxvo/live-assist adds co-browsing, WebRTC calling, recording consent, and remote-control flows on top of @oxvo/browser.

Minimum supported browser SDK version: @oxvo/browser >= 7.1.0.

Install

npm i @oxvo/live-assist

Quick Start

import Browser from '@oxvo/browser';
import liveAssist from '@oxvo/live-assist';

const browser = new Browser({
  siteKey: 'ws_live_01HZX8M4B3',
});

browser.use(
  liveAssist({
    serverURL: 'https://app.oxvo.com',
    socketHost: 'https://app.oxvo.com',
    session_calling_peer_key: 'assist:call',
    session_control_peer_key: 'assist:control',
    onAgentConnect: () => () => console.info('agent disconnected'),
  }),
);

await browser.start({
  userID: 'acct_2048',
});

Common Options

• serverURL: base OxvoSessions application URL used by the assist UI
• socketHost: socket endpoint when it differs from serverURL
• session_calling_peer_key: call-session channel key
• session_control_peer_key: remote-control channel key
• callConfirm, controlConfirm, recordingConfirm: end-user consent copy and button styling
• config: custom WebRTC ICE/TURN configuration
• onAgentConnect, onCallStart, onRemoteControlStart: lifecycle callbacks that may return teardown handlers
• onCallDeny, onRemoteControlDeny, onRecordingDeny: denial hooks for consent flows

SSR Usage

If you initialize the browser SDK from a server-rendered app, import the CommonJS build and start the tracker after the app mounts.

import Browser from '@oxvo/browser/cjs';
import liveAssist from '@oxvo/live-assist/cjs';

Notes

• load Live Assist before calling browser.start(...)
• keep consent copy clear and customer-facing
• align TURN/STUN configuration with your deployment environment when you do not use the default setup

Documentation: https://docs.oxvo.com/plugins/assist