この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

Open CTI 開発者ガイド

Open CTI の使用開始
コールセンター定義ファイル
Open CTI の使用
Lightning Experience のメソッド
Salesforce Classic のメソッド
Salesforce アプリケーション操作用のメソッド
コンピュータテレフォニーインテグレーション (CTI) のメソッド
Salesforce Classic の disableClickToDial()
Salesforce Classic の enableClickToDial()
Salesforce Classic の getCallCenterSettings()
Salesforce Classic の getDirectoryNumbers()
Salesforce Classic の getSoftphoneLayout()
Salesforce Classic の onClickToDial()
Salesforce Classic の setSoftphoneHeight()
Salesforce Classic の setSoftphoneWidth()
その他のリソース
PDF

Salesforce Classic の getSoftphoneLayout()

使用方法

ソフトフォンレイアウトを JSON 文字列として返します。このメソッドは、API バージョン 27.0 以降でのみ使用できます。

構文

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

引数

名前 型 説明
callback function API メソッドコールが完了するときに実行された JavaScript メソッド。

サンプルコード – JavaScript

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>

応答

このメソッドは非同期です。応答は、コールバックメソッドに渡されたオブジェクトで返されます。応答オブジェクトには次の項目が含まれます。

名前 型 説明
result string API コールが正常に行われた場合、ソフトフォンレイアウト定義が JSON 文字列として返されます。API コールが失敗した場合、null が返されます。

返された JSON 文字列には、各通話種別を表す 3 つの要素が含まれます。

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

各通話種別には 3 つのサブセクションが含まれます。

  • "callRelatedFields" — 表示対象として選択された通話関連項目の配列。使用できる値は、"ANI"、"DNIS"、"SEGMENT"、"QUEUE" です。
  • "objects" — 表示対象として選択された Salesforce オブジェクトのセット。各オブジェクトから表示対象として選択された [項目表示ラベル] および [項目名] (API 参照名) も含まれます。
  • "screenPopSettings" — このオブジェクトには、"ExistingWindow" または "NewWindow" のいずれかの値を持つ "screenPopsOpenWithin" 項目が含まれます。また、各画面ポップの一致項目、"NoMatch"、"SingleMatch"、"MultipleMatches" の設定も含まれます。各一致項目には、対応する "screenPopType" 項目が格納されます。また、"screenPopData" 項目が格納される場合もあります。"screenPopType" に "PopToEntity" の値が指定されている場合、"screenPopData" には対象オブジェクトの名前が含まれます。"screenPopType" に "PopToVisualforce" の値が指定されている場合、"screenPopData" には対象オブジェクトの名前が含まれます。"screenPopType" に "PopToSearch" の値が指定されている場合、"screenPopData" 項目は存在しません。

次に、JSON 応答の例を示します。

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 }
error string または未定義 API コールが正常に行われた場合、この変数は未定義です。API コールが失敗した場合、この変数はエラーメッセージを返します。