Conversation / Hide

In the Ozeki Chat Client, the Conversation/Hide API request allows users to discreetly remove specific participants from their view, enhancing control over their communication environment. By invoking the conversation hide action, users can effectively conceal designated users, providing a more tailored and focused interaction experience. Upon successful execution, the API returns the conversation with the hidden user, confirming the successful implementation of the hide functionality within the chat interface.

Hide 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": "hide",
  "conversationid": "8ca16186c36a4e0a1ef2096e6c60b613",
  "hideid": "7sSwU2VoFM;",
  "clientversioncode": 3,
  "timestamp": "2024-03-11 07:42:41"
}

Hide 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": "JCQ...A==",
    "lastmessageid": "",
    "lastreportid": "",
    "lastaccess": 1710142205,
    "secret": "ldD...A==",
    "instance": "7sSwU2VoFM",
    "mutedby": [],
    "favoriteby": [],
    "hiddenby": [],
    "properties": [
      {
        "userid": "d574638619cbff603bf857164c47e850",
        "ismuted": false,
        "isfavorite": false,
        "hideid": "7sSwU2VoFM;",
        "listitembackgroundcolor": "#bae1ff"
      }
    ]
  }
}

More information