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

Quickstart

Get a working browser dialer in about 10 minutes. This guide was validated end-to-end against SDK @latest

Before you start#

You need:
A Convirza account with the Dialer feature enabled and a dialer user (an account with an assigned extension — set up in the Dialer Portal under Users).
That user's Convirza email and password.

Step 1 — Install#

npm:

Step 2 — Initialize the widget#

ESM / bundler:
Script tag / UMD:
init() injects a <convirza-dialer> element into the page, authenticates with your credentials, obtains a SIP session automatically, and registers with Convirza's calling infrastructure. Within a couple of seconds you should see the floating phone button, and the element fires sip-registered.
Declarative alternative — place the element yourself:

Step 3 — Handle authentication events#

Step 4 — Make a call#

Or let users dial manually: click the floating button, type a number, hit the green call button. The browser will prompt for microphone access on the first call — this must be granted.

Step 5 — Verify#

You have a working integration when:
1.
The floating phone button renders after init().
2.
The sip-registered event fires (listen on the <convirza-dialer> element).
3.
An outbound call connects, and appears afterward in the widget's History tab.
4.
The call appears in your Convirza reporting with recording, like any tracked call.

Next steps#

Configuration & Theming — white-label the widget
API Reference — complete method documentation
Events Reference — drive your UI from call events
Modified at 2026-07-14 13:21:18
Previous
Overview
Next
Configuration & Theming
Built with