Ozeki Chat Client API

The Ozeki Chat Client API empowers developers to craft personalized chat clients tailored to specific needs, seamlessly integrating with the Ozeki Chat platform. By leveraging this API, developers can create custom chat applications equipped with features suited to their unique requirements, enabling enriched interactions within the Ozeki ecosystem. Whether it's implementing specialized functionalities, enhancing user experiences, or integrating with existing systems, the Ozeki Chat Client API offers the flexibility and versatility necessary for building robust and tailored chat solutions. In this chapter you can learn about the Ozeki Chat Client API.

API calls

Login: In the Ozeki Chat Client, the Login API request is the initial step when the client connects to the chat server, downloading crucial data essential for interaction. This request retrieves pivotal information such as the user's RSA private key, enabling decryption of conversation data for secure communication. Additionally, the API provides URLs for server communication and the WebSocket address for receiving notifications about changes in friends lists and conversations, enhancing the user's chat experience..
View the Ozeki Chat Client API Login request.

Availability: When the useravailable request is called in the Ozeki Chat Client, it updates the user's availability status to "available," signaling to other users that they are ready for communication. This API request triggers a real-time update across the platform, ensuring that the user's status is accurately reflected to their contacts. By leveraging this functionality, the Ozeki Chat Client facilitates seamless communication by instantly notifying others when a user becomes available for interaction.
View the Ozeki Chat Client API Availibaility request.

Friends / List: When the Friends/List API request is invoked in the Ozeki Chat Client, it retrieves crucial information about a user's friends, including their availability status and unique identifiers. By querying this API, the client efficiently obtains the userId, username, public key, and availability of each friend, facilitating seamless communication. This feature streamlines the user experience by providing comprehensive details about friends, enabling quick and informed decisions on whom to engage with based on availability.
View the Ozeki Chat Client API Friends / List request.

Report: In the Ozeki Chat Client, the Report API request is utilized to report user-specific issues or concerns, requiring the user's unique identifier for proper identification. This identifier, represented by the userid parameter, is generated by computing the MD5 checksum of the user's email address, ensuring anonymity while accurately linking the report to the user. For instance, the email "alice@ozeki.hu" would be transformed into the MD5 hash "aa68d2204cb2bb85f2de3b9aad0d86d7," providing a secure and standardized method for user identification within the reporting system.
View the Ozeki Chat Client API Report request.

Notification: In the Ozeki Chat Client, the Notification API request is employed to send personalized alerts or updates to specific users, requiring their unique identification for targeted delivery. This identification, encapsulated in the userid parameter, is generated by computing the MD5 checksum of the user's email address, ensuring privacy and security in the notification process. For example, by applying the MD5 hash function to "alice@ozeki.hu," the resulting userid "aa68d2204cb2bb85f2de3b9aad0d86d7" uniquely identifies Alice for precise notification targeting within the chat client.
View the Ozeki Chat Client API Notification request.

Conversation/List: When the Conversation/List API request is utilized in the Ozeki Chat Client, it retrieves essential details about all ongoing conversations in which the user is a participant. By leveraging this API action, users can efficiently obtain basic information such as conversation IDs, participants, and timestamps for each conversation. This functionality enables users to manage and navigate their conversations effectively, ensuring seamless communication across multiple threads within the chat client.
View the Ozeki Chat Client API Conversation/List request.

Conversation/Partial download: When employed in the Ozeki Chat Client, the Conversation/Partial download API request facilitates the retrieval of messages from the server, enhancing the user experience during conversation browsing. By utilizing the downloadpartial action, the client efficiently obtains the most recent messages within a conversation, ensuring users are up to date with the latest interactions. This dynamic functionality ensures a seamless user experience by automatically fetching additional messages as users scroll up, providing a continuous stream of conversation content.
View the Ozeki Chat Client API Conversation/Partial download request.

Conversation/Add: In the Ozeki Chat Client, the Conversation / Add API request plays a pivotal role in facilitating real-time communication by enabling users to upload new messages to ongoing conversations. By invoking the conversation add action, users seamlessly contribute to the conversation flow, ensuring that their messages are visible to other participants. Upon successful upload, the API returns pertinent data regarding the uploaded message, enhancing transparency and facilitating smooth interaction within the chat environment.
View the Ozeki Chat Client API Conversation/Add request.

Conversation/Clear: In the Ozeki Chat Client, the Conversation/Clear API request serves as a crucial tool for users to manage conversation content by clearing all messages within a specific conversation. This action, initiated through the conversation clear action, effectively resets the conversation, removing all previous messages and providing a clean slate for future interactions. Upon successful execution, the API returns the cleared conversation, confirming the operation's completion and ensuring clarity in the chat environment.
View the Ozeki Chat Client API Conversation/Clear request.

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.
View the Ozeki Chat Client API Conversation/Favorite request.

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.
View the Ozeki Chat Client API Conversation/Unfavorite request.

Conversation/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.
View the Ozeki Chat Client API Conversation/Change color request.

Conversation/Download: In the Ozeki Chat Client, the Conversation/Download API request, accompanied by headers such as Content-Type, Ozeki-Signature, Ozeki-Station, and Ozeki-User, facilitates the retrieval of conversation data in JSON format. This request allows users to securely access and download conversation content, leveraging specified identifiers such as station ID and user ID to ensure authentication and authorization. By providing essential headers, users can seamlessly integrate conversation data into their applications or workflows, enhancing communication management and analysis capabilities.
View the Ozeki Chat Client API Conversation/Download request.

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.
View the Ozeki Chat Client API Conversation/Mute request.

Conversation/Unmute: In the Ozeki Chat Client, the Conversation/Unmute API request offers users the capability to reverse the mute status of specific participants within conversations, reinstating their ability to receive notifications and engage in communication. By utilizing the conversation unmute action, users can effectively remove the muted tag from designated users, fostering open dialogue and interaction. Upon successful execution, the API returns the conversation with the unmuted user, confirming the restoration of their communication privileges within the chat interface.
View the Ozeki Chat Client API Conversation/Unmute request.

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.
View the Ozeki Chat Client API Conversation/Hide request.

Conversation/Unhide: In the Ozeki Chat Client, the Conversation/Unhide API request enables users to reverse the action of hiding specific participants, restoring their visibility within the chat interface. By utilizing the conversation unhide action, users can select hidden users to be shown once again, facilitating open communication and interaction. Upon successful execution, the API returns the conversation with the previously hidden user, confirming their restoration to visibility within the chat environment.
View the Ozeki Chat Client API Conversation/Unhide request.

Conversation/Blocklist: In the Ozeki Chat Client, the Blocklist API request serves as a tool to reveal the list of users who have been hidden, enabling users to manage their visibility settings effectively. By accessing the blocklist through this API, users can easily identify and unhide specific individuals, fostering transparency and facilitating open communication channels. This functionality streamlines the process of managing blocked or hidden users, ensuring a seamless experience within the chat client.
View the Ozeki Chat Client API Conversation/Blocklist request.

Conversation/Workspace registration: In the Ozeki Chat Client, the Workspace Registration API request, accompanied by headers such as Content-Type, Ozeki-User, and Ozeki-Signature, facilitates the registration of new workspaces within the application. This request enables users to securely register workspaces by providing essential parameters like user ID and signature for authentication and authorization purposes. By adhering to the specified Content-Type and including the necessary authentication headers, users can seamlessly integrate new workspaces into the Ozeki Chat Client environment.
View the Ozeki Chat Client API Conversation/Workspace registration request.

More information