Skip to content

Dialer SDK

A dialer SDK for
your own product.

The Trellus Dialer SDK puts manual, power and parallel calling in your own interface. Your team builds the experience. The SDK runs the dialing.

Version 0.1.0 is an integration preview. Live calling is by arrangement with Trellus.

yourapp.example
Your productYour interface

Your components. Your task list.

Dialer SDK inside.

Dialing modesManual, power & parallel
Live transcriptsTyped events for your interface
Optional interfaceReady-made calling controls
Illustration: calling inside your own application

What the SDK gives you

Three dialing modes.
One JavaScript SDK.

The SDK is headless. Your code renders the call state it publishes and calls its methods when the user acts.

Manual, power, parallel
One call per action, one queued call at a time, or several calls at once with the rep connected to one of them.
Live transcripts
Transcript text arrives during the call. It stays provisional until the final version arrives after the call ends.
Typed events
Six events cover sessions, connections, call endings, transcripts, detection and errors, with TypeScript types.
Optional interface
A separate package with ready-made calling controls and a session viewer. Use it, theme it, or build your own.

SDK or white-label

Your product,
or a branded workspace.

There are three ways to offer Trellus calling. The right one depends on who builds the interface your users see.

01 / Dialer SDK

Calling inside your product

Your engineers embed calling in your own interface. Your application supplies the tasks and saves the outcomes.

Read the quickstart
02 / White-label

A branded Trellus workspace

Your users call from a Trellus workspace with your name, logo and domain. There is no interface for you to build.

Explore white-label dialing
03 / Chrome extension

Calling in a supported CRM

Your reps already work in a CRM or sales platform that Trellus supports. They call from their existing lists with the Trellus extension.

See supported platforms

Who owns what

You own the product.
The SDK owns the dialing.

The split is the same whether you use the optional interface or build your own. There is one scheduling loop, and it lives in the SDK.

Read the ownership split
Trellus: the headless SDK
Task intake, the manual, power and parallel scheduler, call state, pause and wrap-up.
Trellus: the transport
Credentials, audio and backend sessions. One transport places live calls. A mock transport places none.
Trellus: the optional interface
Calling controls that render the SDK’s state. Mounting it does not register audio or dial.
You: your application
Rep sign-in, the task list, contact eligibility and consent, dialing limits, saving call outcomes and completing your own workflow.

A first integration

Build against the mock.
Then go live.

Your engineers can start today without an account. Live calling starts when Trellus enables it for your company.

  1. 01 / Build

    Install and run the mock transport.

    Run npm install @trellusrelease/dialer-sdk @twilio/voice-sdk. The mock transport places no calls and needs no account. Build every state of your interface against it.

  2. 02 / Connect

    Wire your tasks and your save.

    Pass your own task list to the SDK and save each call outcome in your own system. Apply your do-not-call and calling-hours rules before tasks reach the SDK.

  3. 03 / Go live

    Trellus enables live calling.

    Live calling needs a Trellus account, a rep API key, the Twilio Voice SDK and enablement by Trellus. A line setting in code does not grant it.

Where it stands

An integration preview.
Live calling by arrangement.

Version 0.1.0 is public on npm. It is a standalone subset of the Trellus Chrome extension and does not claim full parity with it.

Open to build
Anyone can install the packages and build against the mock transport.
Live by arrangement
Live calling works only for companies Trellus has set up.
Line limits
The headless SDK accepts 1 to 10 lines. The live Trellus transport accepts 1 to 4.
Not included
Provisioning reps or numbers, a credential proxy, CRM task completion, durable call-data delivery, do-not-call and calling-hours filtering, voicemail workflows and recovery.

A few practical questions

Know what fits
before you start.

Bring the details of your platform and calling process to the conversation.

Is there a dialer SDK I can embed in my app?

Yes. The Trellus Dialer SDK is a JavaScript library that puts manual, power and parallel calling inside your own interface. It is on npm as @trellusrelease/dialer-sdk, with an optional interface package, @trellusrelease/dialer-ui. Version 0.1.0 is an integration preview, and Trellus enables live calling for each company.

Read the Dialer SDK overview
Can I use the SDK without a Trellus account?

Yes, to build. Anyone can install the packages and build against the mock transport, which places no calls and needs no account. Live calling needs a Trellus account, a rep API key, the Twilio Voice SDK and enablement by Trellus.

Follow the quickstart
Does the SDK include a UI?

The SDK itself is headless. It publishes call state and takes method calls, so you can build your own interface. A separate optional package provides ready-made calling controls and a read-only session viewer, which you can theme with CSS variables.

See the optional interface
How many lines can it dial at once?

The headless SDK accepts a line limit from 1 to 10. The supplied Trellus transport, which places live calls, accepts 1 to 4. Parallel mode needs at least two lines. A line setting in code does not grant entitlement.

Read about live calling
Which frameworks does it work with?

The SDK is framework-neutral JavaScript with TypeScript declarations. It does not depend on React, a browser extension or a CRM’s API. The optional interface mounts into a plain element, so you can use it from React, Vue or another framework.

See the API reference
How is the Dialer SDK different from a white-label dialer?

White-label dialing is a Trellus workspace under your brand, with your name, logo and domain. The Dialer SDK puts calling inside your own product and your own interface. Your application supplies the tasks and saves the outcomes.

Compare with white-label dialing

Bring your product

Put calling
in your product.

Tell us where your users work, what they call from and where each call outcome should go.