Facebook
LinkedIn
YouTube
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API DocumentationDialer SDK
Getting Started
Authentication
Authentication
  • V2 Authentication (Deprecated)
  • V3 Authentication
V2 API Documentation (Deprecated)V3 API DocumentationDialer SDK
  1. Dialer SDK
  • Overview
  • Quickstart
  • Configuration & Theming
  • API Reference
  • Events Reference
  • Troubleshooting
  1. Dialer SDK

Overview

Embed a full browser softphone in your web app with one script tag or one npm install. The Convirza Dialer SDK renders a floating dialer widget (<convirza-dialer>) that lets your users make and receive calls directly in the browser — no desk phone, no separate app.
Every call placed through the SDK lands in Convirza with recording, transcription, and conversation analytics, on the same pipeline as your tracked inbound calls.

What you get#

Floating widget — a draggable phone button that expands into a full dialer: keypad, call history, audio device selection, caller ID selection, and call parking.
Click-to-call — call convirzaDialer.call('+15551234567') from anywhere in your app (CRM records, contact lists, phone number links).
Incoming calls — desktop notification, ringtone, answer/reject, driven by your Convirza call routing.
In-call controls — mute, hold, keypad (DTMF), and call parking.
White-label theming — your brand name, logo, and colors via attributes or setTheme().
Events for everything — SIP registration, call lifecycle, widget state, and errors, so you can drive your own UI logic.

How it works#

Your web app
  └── @convirza/dialer-sdk  (<convirza-dialer> web component)
        ├── Convirza OAuth ── credential login & session config
        ├── Convirza Dialer API ── caller IDs, phone numbers, parking
        └── SIP over WebSocket (WSS) + WebRTC media ── the actual call
At initialization the SDK authenticates with your Convirza dialer-user credentials, fetches its SIP configuration automatically (domain, extension, STUN/TURN servers), registers with Convirza's SIP infrastructure over secure WebSocket, and is then ready to place and receive calls. You never handle SIP credentials directly.

Requirements#

RequirementDetail
Convirza accountWith the Dialer feature enabled and at least one dialer extension configured (see the Dialer Portal guide)
BrowserChrome 74+, Edge 79+, Firefox 69+, Safari 14.1+
MicrophoneUsers must grant microphone permission on first call
Secure contextPage must be served over HTTPS (or localhost) for microphone and WebRTC access
Audio Device selectionChrome/Edge only (setSinkId browser limitation); Firefox/Safari support microphone selection only

Package#

npm@convirza/dialer-sdk
FormatsESM, CommonJS
TypesTypeScript definitions included
LicenseProprietary — Convirza customers only

Next steps#

1.
Quickstart — working call in about 10 minutes
2.
Configuration & Theming — widget options and white-labeling
3.
API Reference and Events Reference
4.
Troubleshooting — common issues and fixes
Modified at 2026-07-14 13:22:10
Next
Quickstart
Built with