From Bright Pattern Documentation

Revision as of 21:33, 3 April 2026 by Laura.donovan (talk | contribs) (Updated via BpClonePage extension. Source page: draft:Embedded-agent-desktop-api-specification/Methods/dialNumber)

< Previous | Next >
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

dialNumber

Makes a voice call for the logged-in agent, using a specified destination number. Note that only extension numbers of other contact center users can be dialed.

See the Agent Desktop 1.0 SDK Specification's Use Cases section for ways to use this method.

Request

Syntax

window.bpspat.api.dialNumber(phone_number)

Parameters

Parameter Type Description Example
phone_number function Destination phone number (prefix may be required) "14151234567"

Response

Empty. In response to the request, the phone number is dialed.

To get a response, use getState to display agent state and interaction data.

< Previous | Next >