Conversation / List

The conversation api is used for updating the content displayed in a conversation, the conversation list action is used to get basic information of all the conversations the user is a participant of.

Conversation list 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": "list",
  "clientversioncode": 3,
  "timestamp": "2024-03-08 13:55:47"
}

Conversation list response

Response headers Content-Type: application/json
Response data: 
{
  "status": "OK",
  "errormessage": "File does not exist",
  "conversations": [
    {
      "id": "8ca16186c36a4e0a1ef2096e6c60b613",
      "isgroup": false,
      "participantids": [
        "aa68d2204cb2bb85f2de3b9aad0d86d7",
        "d574638619cbff603bf857164c47e850"
      ],
      "participants": [
        {
          "userid": "aa68d2204cb2bb85f2de3b9aad0d86d7",
          "username": "Alice"
        },
        {
          "userid": "d574638619cbff603bf857164c47e850",
          "username": "Administrator"
        }
      ],
      "displayname": "XQx2mPd6...fx3Xc+Q==",
      "lastmessageid": "bd31713d-0f99-453b-a0c1-6311d1fc24c5",
      "lastreportid": "935d8b8de4c395f50405e617e636dbbb",
      "lastaccess": 1709898645,
      "secret": "C7Zw3WH...c8J6HxOsrA==",
      "instance": "PqjfKSn7V8",
      "mutedby": [],
      "favoriteby": [],
      "hiddenby": [],
      "properties": [
        {
          "userid": "aa68d2204cb2bb85f2de3b9aad0d86d7",
          "ismuted": false,
          "isfavorite": false,
          "hideid": "",
          "listitembackgroundcolor": "#ffffff"
        }
      ]
    }
  ]
}

Request parameters

userid: This parameter contains the user id of the user. This field can be calculated by taking the md5 checksum of the user's e-mail address. For example: md5("alice@ozeki.hu") = "aa68d2204cb2bb85f2de3b9aad0d86d7";

timestamp: yyyy-MM-dd hh:mm:ss format, in UTC timezone, it's the client's responsibility to convert it into the local timezone.

More information