From Bright Pattern Documentation
(Created page with "<translate> = 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...") |
(Updated via BpDeleteTranslateTags script) |
||
| (3 intermediate revisions by one other user not shown) | |||
| Line 1: | Line 1: | ||
| − | + | ||
= dialNumber = | = 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. | 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 Embedded Agent Desktop Specification's [[Embedded-agent-desktop-sdk-specification/UseCases/Dial | Use Cases]] section for ways to use this method. | ||
== Request == | == Request == | ||
| Line 12: | Line 14: | ||
| '''Type''' | | '''Type''' | ||
| '''Description''' | | '''Description''' | ||
| + | | '''Example''' | ||
|- | |- | ||
| phone_number | | phone_number | ||
| function | | function | ||
| − | | Destination phone number | + | | Destination phone number (prefix may be required) |
| + | | "14151234567" | ||
|} | |} | ||
== Response == | == Response == | ||
| − | Empty. | + | Empty. In response to the request, the phone number is dialed. |
| − | |||
| − | In response to the request, the phone number is dialed. | ||
To get a response, use [[Embedded-agent-desktop-sdk-specification/Methods/getState | getState]] to display agent state and interaction data. | To get a response, use [[Embedded-agent-desktop-sdk-specification/Methods/getState | getState]] to display agent state and interaction data. | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
Latest revision as of 04:02, 29 May 2024
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 Embedded Agent Desktop 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.