Conversation / Mute

In the Ozeki Chat Client, the Conversation/Mute API request empowers users to manage their conversations by silencing specific participants, effectively reducing distractions or unwanted notifications. By invoking the conversation mute action, users can select designated users to be muted, ensuring a more focused and streamlined communication experience. Upon successful execution, the API returns the conversation with the silenced user, confirming the implementation of the mute functionality within the chat interface.

Mute 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": "mute",
  "conversationid": "8ca16186c36a4e0a1ef2096e6c60b613",
  "clientversioncode": 3,
  "timestamp": "2024-03-11 07:39:08"
}

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

More information