Conversation / Download

In the Ozeki Chat Client, the Conversation/Download API request, accompanied by headers such as Content-Type, Ozeki-Signature, Ozeki-Station, and Ozeki-User, facilitates the retrieval of conversation data in JSON format. This request allows users to securely access and download conversation content, leveraging specified identifiers such as station ID and user ID to ensure authentication and authorization. By providing essential headers, users can seamlessly integrate conversation data into their applications or workflows, enhancing communication management and analysis capabilities.

Download request

Method: POST
URL: ?srv=chatserver&api=chatconversation
Request headers: Content-Type: application/json Ozeki-Signature: signature Ozeki-Station: stationId Ozeki-User: userId
POST data: 
{
  "action": "download",
  "conversationid": "8ca16186c36a4e0a1ef2096e6c60b613",
  "instance": "ZTZqIV8LS5",
  "firstmessagedate": "2024-03-08 15:37:00",
  "firstmessageid": "dbe07fce-f6c7-43bb-8860-1dac3ed0cf77",
  "firstreportdate": "2024-03-08 15:37:02",
  "firstreportid": "5dea31d4-af66-4762-94a1-30fda603c6b7",
  "clientversioncode": 3,
  "timestamp": "2024-03-11 07:34:39"
}

Download response

Response headers Content-Type: application/json
Response data: 
{
  "messages": [
    {
      "ID": "dbe07fce-f6c7-43bb-8860-1dac3ed0cf77",
      "Type": "Message",
      "Created": "2024-03-08 15:37:00",
      "ValidUntil": "2024-03-08 15:38:00",
      "Data": "uwR...A=="
    },
    {
      "ID": "470fa27b-7ecb-4cde-9b49-173c0fca14cb",
      "Type": "Message",
      "Created": "2024-03-11 07:23:46",
      "ValidUntil": "2024-03-18 07:23:46",
      "Data": "RrO...PQ="
    },
    {
      "ID": "7849ae79-efc2-4254-a207-7148e70fbc93",
      "Type": "Message",
      "Created": "2024-03-11 07:29:55",
      "ValidUntil": "2024-03-18 07:23:46",
      "Data": "3/3...6g="
    },
    {
      "ID": "54214d78-e695-4681-b659-dcb734a72ead",
      "Type": "Message",
      "Created": "2024-03-11 07:30:05",
      "ValidUntil": "2024-03-18 07:23:46",
      "Data": "IGM...Uh2"
    }
  ],
  "reports": [
    {
      "ID": "5dea31d4-af66-4762-94a1-30fda603c6b7",
      "Type": "delivered",
      "Created": "2024-03-08 15:37:02",
      "ValidUntil": "2024-03-08 15:38:00",
      "User": "aa68d2204cb2bb85f2de3b9aad0d86d7",
      "Station": "801c91e6466a1ab34945d73ae4f762c6",
      "MessageID": "dbe07fce-f6c7-43bb-8860-1dac3ed0cf77"
    },
    {
      "ID": "8f34d3d8-2373-4707-8320-1382b46fb16d",
      "Type": "viewed",
      "Created": "2024-03-11 07:23:46",
      "ValidUntil": "2024-03-18 07:23:46",
      "User": "d574638619cbff603bf857164c47e850",
      "Station": "0523457bdf9f0fecba7a764cfff20576",
      "MessageID": "470fa27b-7ecb-4cde-9b49-173c0fca14cb"
    },
    {
      "ID": "6a875c03-20e5-4286-8d07-c1e791fbc93d",
      "Type": "viewed",
      "Created": "2024-03-11 07:30:05",
      "ValidUntil": "2024-03-18 07:23:46",
      "User": "d574638619cbff603bf857164c47e850",
      "Station": "0523457bdf9f0fecba7a764cfff20576",
      "MessageID": "54214d78-e695-4681-b659-dcb734a72ead"
    }
  ],
  "status": "OK",
  "errormessage": ""
}

More information