この文章は Salesforce 機械翻訳システムを使用して翻訳されました。詳細はこちらをご参照ください。
英語に切り替える

lightning:omniToolkitAPI (ベータ)

このコンポーネントは、オムニチャネルツールキット用の API へのアクセスを提供します。

lightning:omniToolkitAPI コンポーネント (ベータ) を使用すると、オムニチャネル用のユーティリティバー内のコンポーネントで、エージェントの未完了の作業項目のリストに戻るなどのメソッドを使用できます。オムニチャネルでは、コンソールでエージェントに作業を転送します。

次の例では、エージェントに割り当てられた作業項目を受け入れるボタンをオムニチャネルユーティリティに追加します。

コンポーネントのボタンにより、次のクライアント側コントローラがコールされます。

使用上の考慮事項

すべてのメソッドは非同期であるため、コールバックメソッドのオブジェクトで応答を返します。

メソッド

このコンポーネントは、次のメソッドをサポートします。

acceptAgentWork({workId, callback}): エージェントに割り当てられた作業項目を受け入れます。

  • workId (string): エージェントが受け入れる作業項目の ID。
  • callback (関数): 省略可能。workId に関連付けられた作業項目をエージェントが受け入れたときにコールされる関数。

closeAgentWork({workId, callback}): 作業項目の状況を「完了」に変更し、作業項目リストから削除します。

  • workId (string): 完了した作業項目の ID。
  • callback (関数): 省略可能。workId に関連付けられた作業項目が完了したときにコールされる関数。

declineAgentWork({workId, declineReason, callback}): エージェントに割り当てられた作業項目を却下します。

  • workId (string): エージェントが却下する作業項目の ID。
  • declineReason (string): 省略可能。エージェントが作業要求を拒否した場合に入力された理由。
  • callback (関数): 省略可能。workId に関連付けられた作業項目をエージェントが却下したときにコールされる関数。

getAgentWorks({callback}): 現在エージェントに割り当てられ、エージェントのワークスペースで開いている作業項目のリストを返します。

  • callback (関数): 省略可能。エージェントの作業項目のリストが取得されたときにコールされる関数。

getAgentWorkload({callback}): エージェントに現在割り当てられているワークロードを取得します。このメソッドは、対応可能なエージェントに作業を再転送するために使用します。

  • callback (関数): 省略可能。エージェントの設定された業務量と作業が取得されたときにコールされる関数。

getServicePresenceStatusChannels({callback}): オムニチャネルユーザの現在のプレゼンス状況に関連付けられたサービスチャネルを取得します。

  • callback (関数): 省略可能。プレゼンス状況に関連付けられたチャネルが取得されたときにコールされる関数。

getServivePresenceStatusId({callback}): エージェントの現在のプレゼンス状況を取得します。

  • callback (関数): 省略可能。エージェントのプレゼンス状況が取得されたときにコールされる関数。

login({statusId, callback}): エージェントが特定のプレゼンス状況でオムニチャネルにログインします。

  • statusId (string): プレゼンス状況の ID。
  • callback (関数): 省略可能。statusId に関連付けられたプレゼンス状況でエージェントがログインしたときにコールされる関数。

logout({callback}): エージェントがオムニチャネルからログアウトします。

  • callback (関数): 省略可能。エージェントがオムニチャネルからログアウトしたときにコールされる関数。

setServicePresenceStatus({statusId, callback}): エージェントのプレゼンス状況を特定の ID を持つ状況に設定します。まだログインしていないユーザはプレゼンスにログインされます。これによって、追加のコールを実行する必要がなくなります。

  • statusId (string): エージェントに設定するプレゼンス状況の ID。
  • callback (関数): 省略可能。statusId に関連付けられたプレゼンス状況にエージェントの状況を変更したときにコールされる関数。

属性

属性名 属性型 説明 必須かどうか
body Component[] コンポーネントのボディ。マークアップでは、これはタグのボディに含まれるすべてを指します。