.png?sv=2022-11-02&spr=https&st=2025-12-29T07%3A18%3A57Z&se=2025-12-29T07%3A28%3A57Z&sr=c&sp=r&sig=cCkSDecaodcVy8OfwRwyMMANviF7dtnuoBh5nxfWMao%3D){kind=logo}
Data Synchronization
- DarkLight
Data Synchronization
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
This API is used to synchronize Workspace data with the data available in Salesforce core application.
Pre-requisite
The application registration must be completed.
Sequence Diagram
.jpg?sv=2022-11-02&spr=https&st=2025-12-29T07%3A18%3A57Z&se=2025-12-29T07%3A28%3A57Z&sr=c&sp=r&sig=rfHaVwvBZcDSg7v4Q%2BSP7RktVwkPG5NiYcO6O4369CY%3D)
Message Structure
Request Parameters | Value |
|---|---|
channel | Salesforce |
topic | Call |
subtopic | GetAllData |
source | «Source application name» |
data | «JSON Object» |
Response Parameters | Value |
|---|---|
channel | Salesforce |
topic | Call |
subtopic | AllData |
message | «JSON Object» |
Response Data Parameters
Parameter | Data Type | Description | Sample Value |
|---|---|---|---|
<callId> | JSON Object | Current call details in Salesforce core. | 12345 |
credentials | JSON Object | CTI credentials stored in Salesforce. | N/A |
active_tabs | JSON Object | Active Salesforce tabs. | N/A |
Call Details Parameters | |||
searchCriteria | JSON Object | Search criteria used to fetch Screen Pop data for the call. | N/A |
createdObjects | JSON Object | Salesforce objects created for this call. | N/A |
searchCriteria Details Parameters | |||
searchField | String | Field name used for screen pop. | fromAddress |
searchText | String | Field value used for screen pop. | 9876543210 |
searchCallType | String | Call type searched for and screen pop displayed. | ACD_IN |
searchEvent | String | Event during which the screen pop happened. | ALERTING |
searchObjects | JSON Array | Salesforce objects corresponding to the search. | Empty for NO_MATCH and DIRECT |
searchResult | String | The search result. | SINGLE_MATCH, MULTI_MATCH, NO_MATCH, DIRECT |
searchObjects Details Parameters | |||
id | String | Salesforce object identifier. | 0017F00000ELIkaQAH |
type | String | Salesforce object type. | Contact, Account, etc. |
name | String | Salesforce object name. | Grand Hotels & Resorts Ltd |
createdObjects Details Parameters | |||
Name | String | Salesforce object type created. | Task |
OId | String | AcqueonWorkspace object identifier. | SF1 |
sfid | String | Salesforce object identifier. | 00T7F000027L43nUAC |
DisplayField | String | Object field to be displayed in the UI. | Subject |
DisplayValue | String | Object value to be displayed in the UI. | MyTask |
CTI Credentials Parameters | |||
isError | Boolean | Indicator if the credentials have failed. | false |
Username | String | CTI username stored in Salesforce. | 123456 |
Password | String | CTI password in Salesforce. | abc@abc |
Extension | String | CTI extension stored in Salesforce. | 5051 |
ADFSUsername | String | Need to add. | Test1 |
Active Tabs Parameters | |||
WhatId | JSON Array | List of Salesforce objects, other than contacts and Leads, opened in Salesforce console. | N/A |
WhoId | JSON Array | List of Salesforce contacts and Leads objects, opened in Salesforce console. | N/A |
WhatId WhoId Parameters | |||
sfid | String | Salesforce object identifier. | 507F00000u6VNgQAM |
value | String | Salesforce object name. | Account1 or Test User |
Sample Request
{
"channel": "Salesforce",
"topic": "Call",
"subtopic": "GetAllData",
"source": "myapp"
}Sample Response
Response data contains the following fields:
Call details for each Call ID.
CTI credentials stored in Salesforce.
Active Salesforce tabs grouped by whoid and whatid
{
"channel": "Salesforce",
"topic": "Call",
"subtopic": "AllData",
"data": {
"12345": {
"searchCriteria": {
"searchField": "fromAddress",
"searchText": "4454",
"searchCallType": "ACD_IN",
"searchEvent": "ALERTING"
},
"createdObjects": [
{
"Name": "Task",
"OId": "SF1",
"DisplayField": "Subject",
"sfid": "00T7F000027L43nUAC",
"DisplayValue": ""
},
{
"Name": "Case",
"OId": "SF2",
"DisplayField": "CaseNumber",
"sfid": "5007F00000u6VNgQAM",
"DisplayValue": "00001684"
}
]
},
"67890": {
"searchCriteria": {
"searchField": "fromAddress",
"searchText": "4454",
"searchCallType": "PREROUTE_ACD_IN",
"searchEvent": "ALERTING",
"searchObjects": [
{
"id": "0017F00000ELIkaQAH",
"type": "Account",
"name": "Grand Hotels & Resorts Ltd"
},
{
"id": "0037F00001ghehyQAA",
"type": "Contact",
"name": "Test1"
},
{
"id": "0037F00001bovxyQAA",
"type": "Contact",
"name": "Test2"
}
],
"searchResult": "MULTI_MATCH"
}
},
"credentials": {
"isError": false,
"Username": "123456",
"Password": "acq@123",
"Extension": "5051",
"ADFSUsername": ""
},
"active_tabs": {
"WhatId": [
{
"sfid": "5007F00000u6VNgQAM",
"value": "Account 1"
}
],
"WhoId": [
{
"sfid": "5007F00000u6VNgQAM",
"value": "TestUser"
}
]
}
}
}Was this article helpful?