Returns the softphone layout as a JSON string. This method is only available in API version 27.0 or later.
1sforce.interaction.cti.getSoftphoneLayout(callback:function);| Name | Type | Description |
|---|---|---|
callback | function | JavaScript method executed when the API method call is completed. |
1<html>
2<head>
3 <script type="text/javascript" src="http://domain:port/support/api/27.0/interaction.js"></script>
4 <script type="text/javascript">
5 var callback = function (response) {
6 alert(response.result);
7 }
8 // Calls getSoftphoneLayout
9 sforce.interaction.cti.getSoftphoneLayout(callback);
10</script>
11</head>
12<body></body>
13</html>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. |
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. |
The returned JSON string contains three elements, one for each call type:
"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"—Contains a "screenPopsOpenWithin" field with a value of either "ExistingWindow" or "NewWindow", and settings for each screen pop match type: "NoMatch", "SingleMatch", and "MultipleMatches". Each match type contains a "screenPopType" field and may also contain a "screenPopData" field. If "screenPopType" is "PopToEntity", then "screenPopData" contains the target object name. If it is "PopToVisualforce", then "screenPopData" contains the target Visualforce page name. If it is "PopToSearch", there is no "screenPopData" field.Example result:
1"Internal" : {
2 "callRelatedFields" : [
3 "ANI",
4 "DNIS",
5 ]
6 "objects" : {
7 "User" : [ {
8 "displayName" : "Name",
9 "apiName" : "Name"
10 }
11 ]
12 },
13 "screenPopSettings" : {}
14 },
15 "Inbound" : {
16 "callRelatedFields" : [
17 "ANI",
18 "DNIS",
19 "SEGMENT",
20 "QUEUE"
21 ],
22 "objects" : {
23 "Account" : [ {
24 "displayName" : "Account Name",
25 "apiName" : "Name"
26 }
27 ]
28
29 },
30 "screenPopSettings" : {
31 "NoMatch" : {
32 "screenPopType" : "PopToEntity",
33 "screenPopData" : "Contact"
34 },
35
36 "SingleMatch" : {
37 "screenPopType" : "PopToVisualforce",
38 "screenPopData" : "Visualforce_Page_Name"
39 },
40 "MultipleMatches" : {
41 "screenPopType" : "PopToSearch"
42 }
43 }
44 },
45 "Outbound" : {
46 "callRelatedFields" : [
47 "DNIS"
48 ],
49 "objects" : {
50 "Account" : [ {
51 "displayName" : "Account Name",
52 "apiName" : "Name"
53 }
54 ]
55 },
56 "screenPopSettings" : {}
57 }
58 }
j