Salesforce コンソールインテグレーションツールキット開発者ガイド
jSpring '26 (API version 66.0)
Winter '25 (API version 62.0)
Spring '24 (API version 60.0)
Winter '24 (API version 59.0)
Summer '23 (API version 58.0)
Spring '23 (API version 57.0)
Winter '23 (API version 56.0)
Summer '22 (API version 55.0)
Spring '22 (API version 54.0)
Winter '22 (API version 53.0)
Summer '21 (API version 52.0)
Spring '21 (API version 51.0)
Winter '21 (API version 50.0)
Summer '20 (API version 49.0)
Spring '20 (API version 48.0)
Winter '20 (API version 47.0)
Summer '19 (API version 46.0)
Spring '19 (API version 45.0)
Winter '19 (API version 44.0)
Summer '18 (API version 43.0)
Spring '18 (API version 42.0)
Winter '18 (API version 41.0)
Summer '17 (API version 40.0)
Spring '17 (API version 39.0)
Winter '17 (API version 38.0)
Summer '16 (API version 37.0)
Spring '16 (API version 36.0)
Winter '16 (API version 35.0)
Summer '15 (API version 34.0)
Spring '15 (API version 33.0)
Winter '15 (API version 32.0)
acceptChat()
cancelFileTransferByAgent()
declineChat()
endChat()
getAgentInput()
getAgentState()
getChatLog()
getChatRequests()
getDetailsByChatKey()
getDetailsByPrimaryTabId()
getEngagedChats()
getMaxCapacity()
initFileTransfer()
onAgentSend()
onAgentStateChanged()
onChatCanceled()
onChatCriticalWaitState()
onChatDeclined()
onChatEnded()
onChatRequested()
onChatStarted()
onChatTransferredOut()
onCurrentCapacityChanged()
onCustomEvent()
onFileTransferCompleted()
onNewMessage()
onTypingUpdate()
sendCustomEvent()
sendMessage()
setAgentInput()
setAgentState()
用語集
Live Agent のメソッド
Live Agent により、Web ベースのチャットを使用して顧客または Web サイトの訪問者とリアルタイムに接続できます。詳細は、Salesforce ヘルプの「Salesforce コンソールへの Live Agent の追加」を参照してください。
-
acceptChat()
チャット要求を受け入れます。API バージョン 29.0 以降で使用できます。このメソッドは API バージョン 37.0 以降のオムニチャネルではサポートされていません。 -
cancelFileTransferByAgent()
ファイル転送要求がエージェントによってキャンセルされたことを示します。API バージョン 31.0 以降で使用できます。 -
declineChat()
チャット要求を却下します。API バージョン 29.0 以降で使用できます。このメソッドは API バージョン 37.0 以降のオムニチャネルではサポートされていません。 -
endChat()
エージェントが現在参加しているチャットを終了します。API バージョン 29.0 以降で使用できます。 -
getAgentInput()
特定のチャットキーを持つチャットのチャットログにある、エージェントのテキスト入力領域に現在あるテキストの文字列を返します。API バージョン 29.0 以降で使用できます。 -
getAgentState()
オンライン、退席中、またはオフラインなど、エージェントの現在の Live Agent 状況を返します。API バージョン 29.0 以降で使用できます。 -
getChatLog()
特定のチャットキーに関連付けられたチャットのチャットログを返します。API バージョン 29.0 以降で使用できます。 -
getChatRequests()
エージェントに割り当てられたチャット要求のチャットキーを返します。API バージョン 29.0 以降で使用できます。 -
getDetailsByChatKey()
特定のチャットキーに関連付けられたチャットの詳細を返します。API バージョン 29.0 以降で使用できます。 -
getDetailsByPrimaryTabId()
特定の主タブ ID に関連付けられたチャットの詳細を返します。API バージョン 29.0 以降で使用できます。 -
getEngagedChats()
エージェントが現在参加しているチャットのチャットキーを返します。API バージョン 29.0 以降で使用できます。 -
getMaxCapacity()
エージェントの割り当て済みエージェント設定に指定されているとおりに、現在のエージェントの最大可能チャット数を返します。API バージョン 29.0 以降で使用できます。 -
initFileTransfer()
顧客からエージェントにファイルを転送するプロセスを開始します。API バージョン 31.0 以降で使用できます。 -
onAgentSend()
エージェントが Salesforce コンソールでチャットメッセージを送信するとコールされる関数を登録します。このメソッドにより、メッセージが受信されます。また、このメソッドはメッセージがチャット訪問者に送信される前に発生します。API バージョン 29.0 以降で使用できます。 -
onAgentStateChanged()
オンラインから退席中への変更など、エージェントが Live Agent 状況を変更するとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onChatCanceled()
チャット訪問者がチャット要求をキャンセルするとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onChatCriticalWaitState()
チャットへの応答が不可欠になるか、待機中のチャットが応答されるとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onChatDeclined()
エージェントがチャット要求を却下するとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onChatEnded()
参加していたチャットが終了するとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onChatRequested()
エージェントがチャット要求を受け取るとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onChatStarted()
エージェントが顧客と新しいチャットを開始するとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onChatTransferredOut()
参加していたチャットが別のエージェントに転送されるとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onCurrentCapacityChanged()
エージェントが受け入れ可能なチャット数が変わるとコールされる関数を登録します。たとえば、エージェントが新しいチャットを受け入れて現在参加しているチャットを終了したり、割り当てられているチャットの数が変わったり、チャット要求がチャットキューに入れられたりする場合です。API バージョン 29.0 以降で使用できます。 -
onCustomEvent()
チャット中にカスタムイベントが実行されるとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onFileTransferCompleted()
顧客からエージェントにファイルが転送されるとコールされる関数を登録します。API バージョン 31.0 以降で使用できます。 -
onNewMessage()
顧客、エージェント、またはスーパーバイザから新しいメッセージが送信されるとコールされる関数を登録します。API バージョン 29.0 以降で使用できます。 -
onTypingUpdate()
チャットウィンドウの顧客のテキストが変更されるとコールされる関数を登録します。プレビューが有効になっている場合、この関数は、顧客がチャットウィンドウのテキストを編集するたびにコールされます。プレビューが有効になっていない場合、この関数は、顧客がチャットウィンドウで入力を開始または停止するたびにコールされます。API バージョン 29.0 以降で使用できます。 -
sendCustomEvent()
特定のチャットキーを持つチャットのクライアント側のチャットウィンドウにカスタムイベントを送信します。API バージョン 29.0 以降で使用できます。 -
sendMessage()
特定のチャットキーを持つチャットに、エージェントから新しいチャットメッセージを送信します。API バージョン 29.0 以降で使用できます。 -
setAgentInput()
特定のチャットキーを持つチャットのチャットログにある、エージェントのテキスト入力領域にあるテキストの文字列を設定します。API バージョン 29.0 以降で使用できます。 -
setAgentState()
オンライン、退席中、またはオフラインなど、エージェントの Live Agent 状況を設定します。API バージョン 29.0 以降で使用できます。 -
Live Agent チャット訪問者のメソッド
カスタム Visualforce チャットウィンドウで、Live Agent のチャット訪問者の操作性をカスタマイズするために使用できるメソッドがいくつかあります。