Conversation / Unfavorite

In the Ozeki Chat Client, the Conversation/Unfavorite API request provides users with the ability to remove specific contacts from their list of favorites, ensuring a tailored and streamlined chat experience. By invoking the conversation unfavorite action, users can efficiently manage their preferred contacts, keeping the chat list relevant and organized. Upon successful execution, the API returns the conversation with the selected user, confirming the removal from the special "favorites" group and maintaining clarity within the chat interface.

Unfavorite 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": "unfavorite",
  "conversationid": "8ca16186c36a4e0a1ef2096e6c60b613",
  "clientversioncode": 3,
  "timestamp": "2024-03-11 07:25:52"
}

Unfavorite 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": "IFM...rg==",
    "lastmessageid": "470fa27b-7ecb-4cde-9b49-173c0fca14cb",
    "lastreportid": "d3efea25d6052a7ffad236aba38f5384",
    "lastaccess": 1710141826,
    "secret": "ldD...==",
    "instance": "ZTZqIV8LS5",
    "mutedby": [],
    "favoriteby": [],
    "hiddenby": [],
    "properties": [
      {
        "userid": "d574638619cbff603bf857164c47e850",
        "ismuted": false,
        "isfavorite": false,
        "hideid": "",
        "listitembackgroundcolor": "#ffffff"
      }
    ]
  }
}

More information