Messages
チャットセッション中にエージェントとチャット訪問者間で送信されたすべてのメッセージを返します。
Messages リソースの応答の完全なリストは、「チャット REST API Messages 応答オブジェクト」を参照してください。
構文
- URI
- https://hostname/chat/rest/System/Messages
- 適用開始バージョン
- このリソースは API バージョン 29.0 以降で使用できます。
- 形式
- JSON
- HTTP のメソッド
- GET
- 要求ヘッダー
- X-LIVEAGENT-API-VERSION
- X-LIVEAGENT-AFFINITY
- X-LIVEAGENT-SESSION-KEY
- 要求パラメータ
- なし
- クエリパラメータ
- ack — ack クエリパラメータは、Live Agent サーバのメッセージをポーリングできるようにする順序メカニズムです。Messages 要求を初めて実行すると、ack パラメータは –1 に設定されます。正しい順序でサーバからメッセージを受信するには、次の要求の ack 値を前の応答の sequence 値で更新します。応答コードが 200 (新規メッセージがあった場合の応答) の場合のみ sequence 値が返されます。応答コードが 204 の場合、メッセージはありません。また、クライアントは sequence 値を返しません。この場合、前回の要求と同じ ack 値を使用して Messages 要求を実行します。
- リクエストボディ
- なし
- レスポンスボディ
- Messages 応答