JavaScript SDK
Agent Desktop JavaScript SDK は、npm パッケージであり、Agent Desktopから最新の情報をリクエストできます。この SDK を使用すると、エージェントの詳細、割り当てられたタスク、特定のタスクの詳細、現在のブラウザロケール、シングルサインオン(SSO)統合用の認証トークンなどの情報をリクエストできます。
SDK パッケージを使用すると、次の操作を実行できます。
-
プロパティと属性を通じてウィジェットにデータを渡すようリクエストする。
-
ウィジェット内部のシステムデータを使用、操作することで、より複雑な操作を実行する。
-
非同期で受信するデータをサブスクライブする。
Agent Desktopのイベントには、非同期で発生するものがあります。非同期イベントをサブスクライブし、ペイロード内のデータにアクセスするために、リスナーを追加できます。非同期イベントの例は次のとおりです。
-
新しいタスクが提示された
-
新しいタスクが割り当てられた
-
打診リクエストが作成された
-
打診が終了した
-
スクリーンポップが表示された
非同期イベントの完全なリストについては、「非同期イベント」を参照してください。
はじめに
JavaScript SDK の使用を開始するには、次のいずれかのオプションを選択できます。
-
プロジェクトフォルダで次のコマンドを実行します。
npm install @wxcc-desktop/sdk --save
または
yarn add @wxcc-desktop/sdk
-
次のコマンドを実行して、package.json ファイルにパッケージを追加します。
"dependencies": { "@wxcc-desktop/sdk": "^1.2.2" },
-
Momentum-ui Web コンポーネントライブラリも使用する場合は、次の項目を追加する必要があります。
"peerDependencies": { "@momentum-ui/core": "19.9.2", "@momentum-ui/icons": "7.45.0", "@momentum-ui/utils": "6.2.7", "@momentum-ui/web-components": "^2.0.13", "lit-element": "^2.3.1", "lit-html": "^1.2.1" },
さらに、JavaScript SDK リクエストで返される Promise の型定義にアクセスするためには、次のパッケージをインストールします。
"devDependencies": {
"@wxcc-desktop/sdk-types": "^1.0.2",
...
},
重要 |
Momentum と lit-element の依存関係が |
プロジェクトにパッケージをインストールしたら、ES6 インポートパターンに続けて適切なコンポーネントファイルにパッケージを含める必要があります。
import {Desktop} from "@wxcc-desktop/sdk";