clickToDial
Initiates a phone call, an SMS message, or an email.
Parameters
Name | Data type | Description | Notes |
data | Object | See data object. |
data object
Name | Data type | Description | Notes |
number | String | Phone number that the integration calls. | Use either number or address. Do not use both properties. |
address | String | Email address that the integration sends an email to. | Use either number or address. Do not use both properties. |
<a name="clickToDialType">type</a> | String | Type of interaction. | Values: call, email, sms. <br><br>If no |
autoPlace | Boolean | The integration automatically places a call (true), or the integration populates the Name or Number box with the phone number or the Recipient Email box with the email address (false). | |
queueId | String | ID of the queue to make a call or send an email on behalf of. | |
attributes | Object | Key-value pairs of attributes to add to the interaction. | To use these attributes for screen pops or in interaction logs, add the attributes to |
callerId | String | Phone number displayed to recipients of your phone calls. | Telco support for |
callerIdName | String | Name displayed to recipients of your phone calls. | Telco support for |
utilizationLabelId | String | Categorizes the conversation. Maximum utilization settings can be configured at per-label level. | Agent must be on queue or the queueId field must be populated for the label to display. |
Example
The following example illustrates that when clickToDial is invoked, the embedded agent interface automatically dials the number 317-222-2222 on behalf of a particular queue and screen pops a webpage.
<!-- Intentionally did not add callerId or callerIdName to example. 4/12/19 -->
window.PureCloud.clickToDial ({
number: "3172222222",
type: "call",
autoPlace: true,
queueId: "04a183b6-de9e-4c01-9e88-eabxxxxad0z",
utilizationLabelId: '62f1e0d5-cb8e-4cf7-9049-53dfb00d1983',
attributes: {example_URLPop: "https://www.genesys.com"},
});