Salesforce Classic の searchAndGetScreenPopUrl()

使用方法

特定の文字列に対してソフトフォンレイアウトで指定されたオブジェクトを検索します。検索結果と、ポップ画面への相対 URL を返します。このメソッドは、実際の画面ポップを実行しません。このメソッドは、ソフトフォンレイアウトで定義された画面ポップ設定を優先します。このメソッドは、API バージョン 28.0 以降でのみ使用できます。

このメソッドは、Open CTI API for Lightning Experience では使用できません。Lightning で同じ機能を実現するには、Lightning Experience の searchAndScreenPop() メソッドで使用できる deferred パラメータを使用します。

ヒント

構文

1sforce.interaction.searchAndGetScreenPopUrl(searchParams:string, queryParams:string, callType:string, callback:function)

引数

名前	型	説明
searchParams	string	検索対象の文字列。
queryParams	string	URL に渡すクエリパラメータを指定します。
callType	string	着信、発信、内線、または null などの通話種別を指定します。通話種別は、ソフトフォンレイアウトでの設定ごとに、語句検索を行うオブジェクトを決定します。 callType が null の場合、デフォルトで着信を検索します。callType が内線または発信の場合、画面ポップは表示されません。
callback	function	API メソッドコールが完了するときに実行された JavaScript メソッド。

サンプルコード – JavaScript

1<html>
2<head>
3   <script type="text/javascript" src="http://domain:port/support/api/33.0/interaction.js"></script>
4   <script type="text/javascript">
5       var callback = function (response) {
6           if (response.result) {
7              alert(response.result);
8           } else {
9              alert(response.error);
10           }
11        };
12       function searchAndGetScreenPopUrl() {
13                //Invokes API method
14                sforce.interaction.searchAndGetScreenPopUrl('Acme', 'Key1=value1&Key2=value2', 'inbound', callback);
15        }
16</script>
17</head>
18<body>
19       <button onclick="searchAndGetScreenPopUrl();">searchAndGetScreenPopUrl</button>
20</body>
21</html>

応答

名前	型	説明
result	string	検索結果および URL に一致するオブジェクトのリストを画面ポップ (`screenPopUrl`) に返します。検索は、ソフトフォンレイアウトで指定されたオブジェクトで実行されます。検出されたオブジェクトごとに、オブジェクト ID、項目名、項目値、および API バージョン 33.0 以降の場合はオブジェクトタブ名が JSON 文字列として返されます。次に、「Acme」を検索し、1 ��の取引先オブジェクトと 3 つの商談オブジェクトが検出された例を示します。 `1{"006x0000001ZcyG":{"Name":"Acme - 600 Widgets","object":"Opportunity","displayName":"Opportunity"}, 2"001x0000003DGQR":{"Name":"Acme","Type":"Analyst","object":"Account", 3"displayName":"Company"}, 4"006x0000001ZcyH":{"Name":"Acme - 200 Widgets","object":"Opportunity","displayName":"Opportunity"}, 5"006x0000001ZcyF":{"Name":"Acme - 1,200 Widgets","object":"Opportunity","displayName":"Opportunity"}, 6screenPopUrl:"/search/SearchResults?searchType=2&str=Acme"}` API バージョン 31.0 以降では、個人取引先オブジェクトで API メソッドを呼び出すと追加情報を返します。 `1{"001D000000Jn5C5":{"Name":"PersonAccount","contactId":"003D000000QQCEu", 2"Type":"Analyst","object":"Account","displayName":"Account","personAccount":true}, 3"screenPopUrl":"/001D000000Jn5C5"}`
error	string	API コールが正常に行われた場合、この変数は未定義です。API コールが失敗した場合、この変数はエラーメッセージを返します。

Open CTI 開発者ガイド

使用方法

構文

引数

サンプルコード – JavaScript

応答

関連項目: