Change Color

In the Ozeki Chat Client, the Change Color API request, specifically the conversation "setlistitembackgroundcolor" action, empowers users to customize the visual representation of conversations within the chat list by altering their background colors. By providing the color code and conversation ID in the request, users can swiftly modify the appearance of specific conversations to suit their preferences or organizational needs. Upon successful execution, the API returns the updated conversation, ensuring seamless integration of personalized aesthetics into the chat interface.

Change Color 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": "setlistitembackgroundcolor",
  "conversationid": "8ca16186c36a4e0a1ef2096e6c60b613",
  "color": "#bae1ff",
  "clientversioncode": 3,
  "timestamp": "2024-03-11 07:30:18"
}

Change Color 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