.png?sv=2022-11-02&spr=https&st=2025-12-29T05%3A39%3A45Z&se=2025-12-29T05%3A49%3A45Z&sr=c&sp=r&sig=IytHrktFgxiKsYa2iKldt6JKEmIzOmkCb%2FjdDgX2m7E%3D){kind=logo}
Click to Dial Payload
- DarkLight
Click to Dial Payload
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API allows users to receive the Click to Dial payload event when they click the phone number in the Salesforce Object.
Pre-requisite
The application registration must be completed, and the user must be logged in to Salesforce.
Sequence Diagram
Message Structure
Request Parameters | Value |
|---|---|
channel | Salesforce |
topic | Call |
subtopic | ClickToDialPayload |
source | «Source application name» |
data | «JSON Object» |
Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
Not applicable | |||
Response Parameters | Value |
|---|---|
channel | Salesforce |
topic | Call |
subtopic | CheckTaskState |
message | «JSON Object» |
Response Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
number | String | The phone number clicked by the user. | 9971300712 |
recordId | String | The ID of the record associated with the clicked phone number. | 1230035g00000v6E04AAE45 |
recordName | String | The name of the record associated with the clicked phone number. | Test record |
recordObjectType | String | The type of record associated with the clicked phone number. | Contact |
focusedObjectId | String | If the user navigated to a Salesforce record such as an account or case, the loaded record ID is returned. Otherwise, the field is empty. | 0065g00000X50xNAAR |
focusedObjectName | String | If the user navigated to a Salesforce record such as an account or case, the loaded record name is returned. Otherwise, the field is empty. | Ash2023-03-22 18:44:30 |
focusedObjectType | String | If the user navigated to a Salesforce record such as an account or case, the loaded object type (such as an accrount or a case) is returned. Otherwise, the field is empty. | Opportunity |
focusedObjectURL | String | The URL of the page that the user navigated to. | https://acqueontechnologies4-dev-ed.develop.lightning.force.com/lightning/r/Opportunity/0065g00000X50xNAAR/view |
Sample Request
Not applicable
Sample Response
{
"channel": "Salesforce",
"topic": "Call",
"subtopic": " ClickToDialPayload",
"data":
{
"number": "9971300712",
"recordId": "0035g00000v6E04AAE",
"recordName": "Test Record",
"recordObjectType": "Contact",
"focusedObjectId": "0065g00000X50xNAAR",
"focusedObjectName": "Ash2023-03-22 18:44:30",
"focusedObjectType": "Opportunity",
"focusedObjectUrl": "https://acqueontechnologies4-dev-ed.develop.lightning.force.com/lightning/r/Opportunity/0065g00000X50xNAAR/view"
}
}Was this article helpful?