Dialpad Mini Dialer (CTI)

🚧

Early Beta

The below feature is in an early beta and could potentially have bugs. Please reach out to us at [email protected] should you encounter any issues

Introduction

Dialpad's CTI (mini dialer) provides key features of Dialpad's desktop app - calling and messaging - in a version that can be rendered on Google Chrome. The CTI can be opened in an iframe inside a logged in site. This section describes the steps in which the CTI can be setup and the JavaScript methods that can be used for communicating between your application and the CTI iframe.

Setting up the CTI

The CTI will be hosted on Dialpad and instantiated in an iframe on your logged in website. To setup the CTI, please submit this form and include the following details

Allowed Origins

These are URLs that Dialpad would add to its allow list for accepting Javascript commands. For instance, if the CTI would be rendered in an iframe within example.com, then the domain example.com would need to be specified. Wildcards are also accepted

Additional Headers

Specify custom headers for the iframe using a JSON body.

Loading the CTI

Once the CTI instance is setup by the Dialpad team, a client ID would be provided to you. This ID will be used to load the CTI at the URL https://dialpad.com/apps/<ClientID>. While loading the CTI, please allow microphone, autoplay, camera and display capture access.

For example

<iframe src="https://dialpad.com/apps/clientID" title="Dialpad" allow="microphone; autoplay; camera; display-capture" sandbox="allow-popups allow-scripts allow-same-origin" frameborder=0 style="width:400px; height:520px;"></iframe>

When a user would have to login to Dialpad when the CTI is first loaded or after every time the user logs out of Dialpad.

Supported JavaScript Methods

We support a few JS methods through the window.postMessage() method by using the postMessage API.

Field definition for the window.postMessage() method:

FieldTypeRequired?Description
apistringtrueThis specifies the name of the API and should be defaulted to opencti_dialpad
versionstringtrueThe version of the API. It should be defaulted to 1.0
methodstringtrueThe name of the method. We support the following methods:

1. When message is received by the CTI: initiate_call, enable_current_tab

2. When message is sent from CTI: call_ringing, user_authentication.
payloadJSONfalseParameters and their values that are needed when using the JS API method.
Payload is not required in method enable_current_tab

The methods supported by Dialpad at this time are listed below

user_authentication

This message is posted when the authentication state of a user in the Dialpad CTI changes. The payload parameters of this message are:

ParameterDescription
user_authenticatedIf the user is logged in, true is passed, else false
user_idDialpad ID (long) of the user that is logged in/out

Example:

window.postMessage({
  'api': 'opencti_dialpad',
  'version': '1.0',
  'method': 'user_authentication',
  'payload': {
    'user_authenticated': true,
    'user_id': 1234567
  }
}, 'https://dialpad.com');

enable_current_tab

Dialpad allows only one CTI tab to be enabled at a time to make and receive calls. This method allows the tab to enable the CTI for calling. There is no payload for this method.

Example:

window.postMessage({
  'api': 'opencti_dialpad',
  'version': '1.0',
  'method': 'enable_current_tab'
}, 'https://dialpad.com');

initiate_call

The initiate_call method opens up the dial prompt in the CTI window and an outbound call will be made automatically if the CTI tab is enabled. If the CTI tab is disabled, this method will enable this tab. The following parameters are supported with this method

ParameterRequiredDescription
enable_current_tabfalseIndicates whether the current tab should be enabled before initiating the call. Default to true
phone_numbertruePhone number in E.164 format
identity_typefalseInitiate calls through groups (Office, Department, or Call Center). The specified values are

Office - Office
Department - OfficeGroup
Call Center - CallCenter
identity_idfalse but required if identity_type is includedThe office, department, or call centre ID
custom_datafalseData to associate with the call. This data is passed back in call events. Maximum 2000 characters.

Example:

window.postMessage({
  'api': 'opencti_dialpad',
  'version': '1.0',
  'method': 'initiate_call',
  'payload': {
    'enable_current_tab': false,
    'phone_number': '+15555555555',
    'identity_type': 'CallCenter',
    'identity_id': 1234567,
    'custom_data': 'any string'
  }
}, 'https://dialpad.com');

call_ringing

This message is posted by Dialpad when an inbound call starts or finishes ringing. Use this message to open the CTI window for the user to answer the call. The payload of this method has the following parameter:

ParameterDescription
stateSet to on when the call starts ringing and to off when the ringing ends. Two messages are sent per call.

Example:

window.postMessage({
  'api': 'opencti_dialpad',
  'version': '1.0',
  'method': 'call_ringing',
  'payload': {
    'state': 'on'
  }
}, 'https://dialpad.com');