使用方法
ソフトフォンレイアウトを JSON 文字列として返します。このメソッドは、API バージョン 27.0 以降でのみ使用できます。
引数
| callback |
function |
API メソッドコールが完了するときに実行された JavaScript メソッド。 |
応答
このメソッドは非同期です。応答は、コールバックメソッドに渡されたオブジェクトで返されます。応答オブジェクトには次の項目が含まれます。
| 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 応答の例を示します。
|
| error |
文字列型または未定義 |
API コールが正常に行われた場合、この変数は未定義です。API コールが失敗した場合、この変数はエラーメッセージを返します。 |
j