概要
エージェントデスクトップ 1.0 SDK は、エージェントの状態や対応に関する情報の取得、およびエージェントやスーパーバイザーのログイン、ステータス、コールフロー、通話録音、転送、発信操作のコントロールに使用されます。
この SDK の使用例や活用事例については、 『エージェントデスクトップ 1.0 SDK 仕様書』.
サポートされているメソッド
この SDK は、エージェントの状態、発信および転送、インタラクションの完了と終了、および通話録音のコントロールといった種類のメソッドをサポートしています。
エージェントの状態に関する メソッドは、エージェントの状態やインタラクション情報の取得、およびエージェントの状態の変更に使用されます。
発信および転送
メソッドは、電話番号の発信やコールの転送に使用されます。
「インタラクションの完了および終了」
メソッドは、インタラクションを完了および終了させるために使用されます。
通話録音のコントロール
メソッドは、通話録音のコントロールや、通話録音のステータスの取得に使用されます。
- muteCallRecordings()
- unmuteCallRecordings()
- getCallRecordingStatus(コールバック)
- startCallRecording(コールバック)
- stopCallRecording(コールバック)
- muteCallRecording(コールバック)
- unmuteCallRecording(コールバック)
サポートされているイベント
本SDKでは、エージェントのログイン、エージェントのステータス、およびコールフローの各イベントをサポートしています。
エージェントのログイン イベントは、エージェントがエージェントデスクトップにログインしているか、ログアウトしているかを表示するために使用されます。 onAgentLogin(コールバック)
エージェントステータス
イベントは、エージェントの状態やその理由を取得するために使用されます。
コールフロー
イベントは、進行中のインタラクションおよび完了したインタラクションに関する情報を取得するために使用されます。 addInteractionRenderedHandler(コールバック)
構文
本仕様におけるすべてのメソッドおよびイベントの構文には、オブジェクト `window.bpspat.api` が含まれます。 このオブジェクトは、次のようにスクリプトファイルが外部Webページに組み込まれた際に作成されます:
<SCRIPT type="text/javascript" src="https://<tenantUrl>/agentdesktop/app/lib/servicepattern-sdk-v1.js"></SCRIPT>
なお、スクリプトのソースコードでは、<TENANTURL> を実際の Web サーバーの URL に置き換えてください。例:
<SCRIPT type="text/javascript" src="https://example.brightpattern.com/agentdesktop/app/lib/servicepattern-sdk-v1.js"></SCRIPT>