Open CTI Developer Guide

Clouds with binary code floating aboveCloud with binary code floating above

No Results

Search Tips:

  • Please consider misspellings
  • Try different search keywords
Get Started with Open CTI
Call Center Definition Files
Working with Open CTI
Methods for Lightning Experience
Methods for Salesforce Classic
Methods for Salesforce Application Interaction
Methods for Computer-Telephony Integration (CTI)
disableClickToDial() for Salesforce Classic
enableClickToDial() for Salesforce Classic
getCallCenterSettings() for Salesforce Classic
getDirectoryNumbers() for Salesforce Classic
getSoftphoneLayout() for Salesforce Classic
onClickToDial() for Salesforce Classic
setSoftphoneHeight() for Salesforce Classic
setSoftphoneWidth() for Salesforce Classic
Other Resources
PDF

getSoftphoneLayout() for Salesforce Classic

Usage

Returns the softphone layout as a JSON string. This method is only available in API version 27.0 or later.

Syntax

sforce.interaction.cti.getSoftphoneLayout(callback:function);

Arguments

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

Sample Code–JavaScript

<html>
<head>
   <script type="text/javascript" src="http://domain:port/support/api/27.0/interaction.js"></script>
   <script type="text/javascript">
       var callback = function (response) {
               alert(response.result);
           } 
       // Calls getSoftphoneLayout
       sforce.interaction.cti.getSoftphoneLayout(callback);
</script>
</head>
<body></body>
</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
result string If the API call was successful, the softphone layout definition is returned as a JSON string. If the API call failed, null is returned.

The returned JSON string contains three elements that represent each of the call types:

  • "Internal"
  • "Inbound"
  • "Outbound"

Each call-type contains three subsections:

  • "callRelatedFields"—An array of call-related fields selected to display. Possible values are "ANI", "DNIS", "SEGMENT", and "QUEUE".
  • "objects"—The set of Salesforce objects selected to display, along with the Field Label and Field Name (API name) selected to display from each object.
  • "screenPopSettings"—This object contains a "screenPopsOpenWithin" field with a value of either "ExistingWindow" or "NewWindow". Additionally, it contains the settings for each of the screen pop match types: "NoMatch", "SingleMatch", "MultipleMatches". Each match type contains a corresponding "screenPopType" field and may also contain a "screenPopData" field. If "screenPopType" has a value of "PopToEntity", then "screenPopData" contains the name of the target object. If "screenPopType" has a value of "PopToVisualforce", then "screenPopData" contains the name of the target Visualforcepage. If "screenPopType" has a value of "PopToSearch", then there won’t be a "screenPopData" field.

The following is an example of a JSON response:

"Internal" : {
   "callRelatedFields" : [
    "ANI",  
    "DNIS", 
   ]
   "objects" : {
    "User" : [ {
      "displayName" : "Name",
      "apiName" : "Name"
     }
    ]
   },
   "screenPopSettings" : {}
  },
  "Inbound" : {
   "callRelatedFields" : [
    "ANI",
    "DNIS",
    "SEGMENT",
    "QUEUE"  
   ],
    "objects" : {
    "Account" : [ {
      "displayName" : "Account Name",
      "apiName" : "Name"
     }
    ]
     
   },
   "screenPopSettings" : {
    "NoMatch" : {
     "screenPopType" : "PopToEntity",
     "screenPopData" : "Contact"  
    },
     
    "SingleMatch" : {
     "screenPopType" : "PopToVisualforce",
     "screenPopData" : "Visualforce_Page_Name"
    },
    "MultipleMatches" : {
     "screenPopType" : "PopToSearch"
    }
   }
  },
  "Outbound" : {
   "callRelatedFields" : [
    "DNIS"  
   ],
   "objects" : {
    "Account" : [ {
      "displayName" : "Account Name",
      "apiName" : "Name"
     }
    ]
   },
   "screenPopSettings" : {}
  }
 }
error string or undefined If the API call was successful, this variable is undefined. If the API call failed, this variable returns an error message.