getCallCenterSettings() for Lightning Experience

Usage

Returns the call center settings associated with the current user. This method is available in API version 38.0 or later.

Syntax

1sforce.opencti.getCallCenterSettings({
2     callback: FUNCTION
3});

Arguments

Name	Type	Description
`callback`	function	JavaScript method executed when the API method call is completed.

Sample Code–HTML and JavaScript

1<html>
2  <head>
3    <script type="text/javascript" src="https://domain:port/support/api//lightning/opencti_min.js"></script>
4    <script type="text/javascript">
5      var callback = function(response) {
6         if (response.success) {
7            console.log('API method call executed successfully! returnValue:', response.returnValue);
8         } else { 
9            console.error('Something went wrong! Errors:', response.errors);
10         } 
11      };
12
13      function getCallCenterSettings() {
14          sforce.opencti.getCallCenterSettings({callback: callback});
15      }
16     </script>
17  </head>
18  <body>
19    <button onclick="getCallCenterSettings();">getCallCenterSettings()</button>
20  </body>
21</html>

Response

This method is asynchronous. The response is returned in an object passed to a callback method. The response object contains the following fields.

Name	Type	Description
`success`	boolean	Returns `true` if the API method call was invoked successfully, `false` otherwise.
`returnValue`	object	If the API call is successful, the call center settings are returned. If the API call fails, `null` is returned.
`error`	array	If the API call was successful, this variable is `null`. If the API call failed, this variable returns an array of error messages.

Example returnValue:

1{
2  "/displayNameLabel":"Display Name",
3  "/internalNameLabel":"InternalName",
4  "/label":"Demo Call Center Adapter",
5  "/reqDialingOptions/label":"Dialing Options",
6  "/reqDialingOptions/reqInternationalPrefix":"01",
7  "/reqDialingOptions/reqInternationalPrefix/label":"International Prefix",
8  "/reqDialingOptions/reqInternationalPrefix/sortOrder":"2.0",
9  "/reqDialingOptions/reqLongDistPrefix":"1",
10  "/reqDialingOptions/reqLongDistPrefix/label":"Long Distance Prefix",
11  "/reqDialingOptions/reqLongDistPrefix/sortOrder":"1.0",
12  "/reqDialingOptions/reqOutsidePrefix":"9",
13  "/reqDialingOptions/reqOutsidePrefix/label":"Outside Prefix",
14  "/reqDialingOptions/reqOutsidePrefix/sortOrder":"0.0",
15  "/reqDialingOptions/sortOrder":"1.0",
16  "/reqGeneralInfo/label":"General Information",
17  "/reqGeneralInfo/reqAdapterUrl":"/apex/ContactCenter",
18  "/reqGeneralInfo/reqAdapterUrl/label":"CTI Adapter URL",
19  "/reqGeneralInfo/reqAdapterUrl/sortOrder":"2.0",
20  "/reqGeneralInfo/reqDisplayName":"Demo Call Center Adapter",
21  "/reqGeneralInfo/reqInternalName":"OpenCTI",
22  "/reqGeneralInfo/reqSalesforceCompatibilityMode":"Classic_and_Lightning",
23  "/reqGeneralInfo/reqSalesforceCompatibilityMode/label":"Salesforce Compatibility Mode",
24  "/reqGeneralInfo/reqSalesforceCompatibilityMode/sortOrder":"8.0",
25  "/reqGeneralInfo/reqSoftphoneHeight":"550",
26  "/reqGeneralInfo/reqSoftphoneHeight/label":"Softphone Height",
27  "/reqGeneralInfo/reqSoftphoneHeight/sortOrder":"6.0",
28  "/reqGeneralInfo/reqSoftphoneWidth":"400",
29  "/reqGeneralInfo/reqSoftphoneWidth/label":"Softphone Width",
30  "/reqGeneralInfo/reqSoftphoneWidth/sortOrder":"7.0",
31  "/reqGeneralInfo/reqStandbyUrl":"/apex/ContactCenter",
32  "/reqGeneralInfo/reqStandbyUrl/label":"CTI Adapter URL2",
33  "/reqGeneralInfo/reqStandbyUrl/sortOrder":"3.0",
34  "/reqGeneralInfo/reqTimeout":"10000",
35  "/reqGeneralInfo/reqTimeout/label":"Timeout",
36  "/reqGeneralInfo/reqTimeout/sortOrder":"4.0",
37  "/reqGeneralInfo/reqUseApi":"true",
38  "/reqGeneralInfo/reqUseApi/label":"Use CTI API",
39  "/reqGeneralInfo/reqUseApi/sortOrder":"5.0",
40  "/reqGeneralInfo/sortOrder":"0.0",
41  "/reqPhoneDemoSettings/label":"Phone Demo Settings",
42  "/reqPhoneDemoSettings/reqIncomingNumber":"(415) 555-1212 (tel:4155551212)",
43  "/reqPhoneDemoSettings/reqIncomingNumber/label":"Simulated Incoming Phone Number",
44  "/reqPhoneDemoSettings/reqIncomingNumber/sortOrder":"0.0",
45  "/reqPhoneDemoSettings/reqProvider":"DummyProvider",
46  "/reqPhoneDemoSettings/reqProvider/label":"CTI Provider",
47  "/reqPhoneDemoSettings/reqProvider/sortOrder":"1.0",
48  "/reqPhoneDemoSettings/reqProviderAccount":"AXXXXXXXXXXXXXXXXX",
49  "/reqPhoneDemoSettings/reqProviderAccount/label":"Provider Account",
50  "/reqPhoneDemoSettings/reqProviderAccount/sortOrder":"2.0",
51  "/reqPhoneDemoSettings/reqProviderAuthToken":"YYYYYYYYYYYYYYYYYY",
52  "/reqPhoneDemoSettings/reqProviderAuthToken/label":"Provider Auth Token",
53  "/reqPhoneDemoSettings/reqProviderAuthToken/sortOrder":"3.0",
54  "/reqPhoneDemoSettings/reqProviderCallerNumber":"415555555",
55  "/reqPhoneDemoSettings/reqProviderCallerNumber/label":"Provider Caller Number",
56  "/reqPhoneDemoSettings/reqProviderCallerNumber/sortOrder":"4.0",
57  "/reqPhoneDemoSettings/sortOrder":"2.0"
58}