Conversation / Favorite

In the Ozeki Chat Client, the Conversation/Favorite API request allows users to prioritize specific contacts by marking them as favorites, ensuring their visibility at the top of the chat list. Through the conversation favorite action, users can easily access important conversations with preferred contacts, enhancing efficiency in communication management. Upon successful execution, the API returns the conversation with the selected user, confirming the successful prioritization of the contact within the chat interface.

Favorite 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": "favorite",
  "conversationid": "8ca16186c36a4e0a1ef2096e6c60b613",
  "clientversioncode": 3,
  "timestamp": "2024-03-08 15:29:51"
}

Favorite response

Response headers Content-Type: application/json
Response data: 
{
  "status": "OK",
  "errormessage": "",
  "conversation": {
    "id": "8ca16186c36a4e0a1ef2096e6c60b613",
    "isgroup": false,
    "participantids": [
      "aa68d2204cb2bb85f2de3b9aad0d86d7",
      "d574638619cbff603bf857164c47e850"
    ],
    "participants": [
      {
        "userid": "aa68d2204cb2bb85f2de3b9aad0d86d7",
        "username": "Alice"
      },
      {
        "userid": "d574638619cbff603bf857164c47e850",
        "username": "Administrator"
      }
    ],
    "displayname": "qPi...Mg==",
    "lastmessageid": "",
    "lastreportid": "",
    "lastaccess": 1709907168,
    "secret": "C7Z...OsrA==",
    "instance": "ZTZqIV8LS5",
    "mutedby": [],
    "favoriteby": [
      "aa68d2204cb2bb85f2de3b9aad0d86d7"
    ],
    "hiddenby": [],
    "properties": [
      {
        "userid": "aa68d2204cb2bb85f2de3b9aad0d86d7",
        "ismuted": false,
        "isfavorite": true,
        "hideid": "",
        "listitembackgroundcolor": "#ffffff"
      }
    ]
  }
}

More information