Live Agent REST API 開発者ガイド
Spring '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)
Live Agent REST リソースの理解
Live Agent API エンドポイントを使用した要求の実行
要求ヘッダー
メッセージの long polling ループ
ChasitorNotTyping
ChasitorSneakPeek
ChasitorTyping
ChatEnd
ChatMessage
CustomEvent
AgentDisconnect
AgentNotTyping
AgentTyping
ChasitorSessionData
ChatEnded
ChatEstablished
ChatMessage
ChatRequestFail
ChatRequestSuccess
ChatTransferred
CustomEvent
NewVisitorBreadcrumb
QueueUpdate
MultiNoun
Live Agent REST API のリクエストボディ
Live Agent REST API のレスポンスボディ
Live Agent REST API のデータ型
状況コードとエラー応答
Live Agent REST API Messages 応答オブジェクト
Messages 要求では、エージェントと顧客のチャット中に発生したすべてのイベントを表すオブジェクトの配列が返されます。
チャット中に発生したイベントによっては、この要求で返される一意のレスポンスボディに複数のサブタイプが含まれる場合があります。
次に、Messages 応答の配列の構造の例を示します。
-
AgentDisconnect
エージェントがチャットから切断されたことを示します。 -
AgentNotTyping
エージェントがチャット訪問者にメッセージを入力していないことを示します。 -
AgentTyping
エージェントがチャット訪問者にメッセージを入力していることを示します。 -
ChasitorSessionData
チャット訪問者の現在のチャットセッションデータを返します。この要求は、ResyncSession 要求の送信後にチャット訪問者のセッションデータを復元するために使用されます。 -
ChatEnded
チャットが終了したことを示します。 -
ChatEstablished
エージェントがチャット要求を受け入れて、訪問者とのチャットに参加していることを示します。 -
ChatMessage
エージェントからチャット訪問者に新しいチャットメッセージが送信されたことを示します。 -
ChatRequestFail
チャット要求が失敗したことを示します。 -
ChatRequestSuccess
チャット要求が成功し、対応可能なエージェントに転送されたことを示します。 -
ChatTransferred
チャットがエージェント間で転送されたことを示します。 -
CustomEvent
チャット中にエージェントからチャット訪問者にカスタムイベントが送信されたことを示します。 -
NewVisitorBreadcrumb
チャット訪問者が現在表示している Web ページの URL を示します。 -
QueueUpdate
チャットキュー内のチャット訪問者の位置が変更された場合に、チャットキュー内での訪問者の新しい位置を示します。