Salesforceのイベント


注意:この記事は、PureCloud for Salesforceに適用されます。

SalesforceクラシックのSalesforceコンソールまたはLightning Experienceのすべてのバージョンで、イベントを起動または待機するように統合を設定できます。イベントの種類とそれらを起動またはリスンする方法は、使用するSalesforceユーザーインターフェースによって異なります。

注意:この記事は、Salesforceに精通している開発者を対象とした高度なカスタマイズのトピックです。

Salesforce コンソール統合ツールキットのイベント モデルを通じて、統合が発生し、次の項目を中心に発生するイベントをリッスンします。:

  • 状態の変更 (使用可能、ビジー、退出、不在、キューなど))
  • コール アクティビティ (接続済み、切断済み、ACW が必要、ACW が完了しました))
  • インタラクション状態の変更(ピックアップ、切断、ミュート、ホールド、セキュア一時停止))

開発者はこれらのイベントを使用するVisualforceページを作成できます。コード例については、「 Salesforce クラシック コンソール アプリケーション ( GitHub ) の イベント」を参照してください。

Salesforceコンソールについては、を参照してください。 Salesforceクラシックのカスタムコンポーネントでコンソールをカスタマイズする Salesforceドキュメントにあります。

イベントモデルの使用については、 Salesforce Salesforceクラシック用コンソール統合ツールキット Salesforceドキュメントにあります。

イベント

統合では、次のイベントを発生させ、 Salesforce に送信できます。

注意:これらのイベント名はで始まります inin.salesforce.constants.consoleevent.pc。の後にテーブル内の名前が続きます。次に例を示します。 inin.salesforce.constants.consoleevent.pc.UPDATE_STATUS。
イベント名 ボディ例 説明
UPDATE_STATUS

{
" ;理由" ;:「status_updated」、
「 ステータス 」:「利用可能」、
「id」:「44560c74-5e84-4062-94b6-5680cdeb54d5」、
「sub_status」:「在宅勤務」
}

ステータスアップデート。セカンダリ ステータスを使用している場合、応答にはセカンダリ ステータスの情報が含まれます。
INTERACTION_CONNECTED {
" ;理由" ;:「接続」、
「interactionId」:“ 44560c74-5e84-4062-94b6-
5680cdeb54d5″
}
相互作用がつながった。
INTERACTION_DISCONNECTED {
" ;理由" ;:「切断」、
「interactionId」:“ 44560c74-5e84-4062-94b6-
5680cdeb54d5″
}
対話が切断されました。
LOGGED_OUT {
" ;理由" ;:「logged_out」
}
ユーザーがログアウトしました。
ACW_REQUIRED {
" ;理由" ;:「acw_required」、
「interactionId」:“ 44560c74-5e84-4062-94b6-
5680cdeb54d5″
}
ACWが必要です。
ACW_COMPLETED {
" ;理由" ;:「acw_completed」、
「interactionId」:“ 44560c74-5e84-4062-94b6-
5680cdeb54d5″
}
ACWが完了しました。
INTERACTION_EVENT {
" ;理由" ;:"インタラクション",
"データ": {
"カテゴリ": 「 <interaction state change> 」,
"データ": {
}
}
}

相互作用状態の変化。

カテゴリの有効な値: 変更、追加します。

Sureforceの場合はPureCloudを使用したCommunicate

統合では、ステータスの変更とエージェントのステータスの変更に関する次のアクションが公開されます。

注意このアクション名は inin.salesforce.constants.consoleevent. で始まり、その後にテーブル内の名前 ( inin.salesforce.constants.consoleevent.changestatus など) が続きます。
アクション名 ボディ例 説明
ステータスを変更する <status>

状況が変わります。リクエストのステータス ID を送信します。

注意:プライマリ ステータスのみを使用する場合は、ステータス ID の代わりにハイレベル キーの値を送信できます。「AVAILABLE」、「AWAY」、「BUSY」、「OUT_OF_OFFICE」、「ON_QUEUE」、「BREAK」、「TRAINING」、「MEETING」、「MEAL」。

変更状態 {
"アクション": 「 <targeted state> 」,
「id」:「 <targeted interaction> 」
}

ターゲットインタラクション状態と ID。

postMessage Web API を使用すると、統合によって、状態の変更、対話状態の変更、および対話イベント、通知イベント、または UserActions イベントのサブスクリプションに関して発生するイベントを起動してリッスンできます。

コード例については、「 Salesforce Lightning アプリケーション ( GitHub ) の イベント」を参照してください。

イベント

イベント名 説明
ハンドシェーク もし クライアントイベントを有効にする コールセンター設定でが選択されている場合、統合はクライアントがロードされるたびにハンドシェイクイベントを発生させます。ハンドシェイクイベントは、LightningコンポーネントがSalesforceクライアントに対してPureCloudにイベントを発生させることができる必要があるというコンテキストを提供します。
インタラクション インタラクション状態の変更を起動します。詳細については、 申し込む メソッド PureCloud埋め込み可能フレームワーク ドキュメント(デベロッパーセンター)
通知 通知状態の変更を起動します。詳細については、 購読するのメソッド PureCloud埋め込み可能フレームワーク ドキュメント(デベロッパーセンター)
UserAction ユーザーアクション状態の変更を起動します。詳細については、 申し込む メソッド PureCloud埋め込み可能フレームワーク ドキュメント(デベロッパーセンター)
注意:PureCloud埋め込みフレームワークのドキュメントに記載されているすべてのコールバックパラメータは、追加されたルートタイプとともにpostMessageデータペイロードで利用できます。下の表を参照 Sureforceの場合はPureCloudを使用したCommunicate

管理者は、統合が起動してイベントを待機するようにコールセンター設定を構成します。

統合を構成する

  1. 選択する クライアントイベントを有効にする コールセンターの設定で。

    この設定により、クライアントがロードするたびに統合によってハンドシェイクイベントが発生します。

  2. (オプション)下 クライアントイベントタイプ、サブスクライブする他のイベント(Interaction、Notification、およびUserAction)を選択します。クリック 矢印  下に追加します 選ばれた
  3. (オプション)選択 チャット通知を展開 チャット通知イベントの拡張ペイロードを受信します。
  4. 保存するをクリックします。

詳細については、 コールセンターの設定

Sureforceの場合はPureCloudを使用したCommunicate

次の表は、Salesforceクライアント用のPureCloudクライアントがlistenする使用可能なタイプの一覧です。これらのタイプはpostMessage Web APIを通して発生します。

タイプ ボディ例
PureCloud.User.updateStatus {
タイプ:「PureCloud.User.updateStatus」、
データ:{
id:「<status ID or system presence>」
}
}
PureCloud.User.updateState {
タイプ:「PureCloud.User.updateState」、
データ:{
アクション: 「 <action> 」,
id:「 <interaction ID> 」
}
}

Lightningコンポーネントを作成する(開発者)

Salesforceがコールセンター設定で選択されたイベントをリッスンしてSalesforceできるように、照明コンポーネントを作成します。

  1. Apex、コンポーネント、およびJavaScriptファイルをSalesforce開発者コンソールに追加します。

    サンプルファイルは次からダウンロードできます。 PureCloud for Salesforce Einsteinの例 GitHubリポジトリ。

    詳細については、 開発者コンソールのファイルメニュー Salesforceドキュメント。

  2. をセットする タイプ そして id JavaScriptファイルのソース用。

    この設定により、クライアントのステータスを変更できます。

    source.postMessage({
        type: 'UpdateStatus',
        id: '<status ID or system presence>' 
    }
  3. 管理者がインタラクション、通知、またはUserActionsイベントを起動するように統合を構成した場合、JavaScriptファイルでこれらのイベントをサブスクライブします。

    詳細については、 申し込む メソッド PureCloud Embeddable Framework ドキュメント(開発者センター)。

統合について詳しくは、以下を参照してください。 SalesforceのPureCloudについて