Release Notes
2025-01
Release date: 2025-01-06
New Features
| Feature | Description | Method |
|---|---|---|
| Multi-item Messages | ZIM newly supports multi-item messages, allowing multiple content items in a single message, including text, images, audio, video, files, and custom messages. This message type enables various combinations such as text + image, text + video, and text + audio to flexibly meet diverse scenarios. | MessageBody Description |
| Query Messages | ZIM server supports querying multiple messages within a single specified conversation (one-to-one chat or group chat) by passing a list of MsgSeq. | Query Messages |
| Callbacks Related to Message Sending | When the message type is a media message, developers can obtain detailed information such as the original image dimensions, large image dimensions, thumbnail dimensions, and video first-frame dimensions through these two callbacks. | |
| Width/Height Field Correction | When calling the server APIs to send image or video messages, ZIM server will check the width and height fields for images and video first-frame. If the fields are incorrect, ZIM server will correct them. | |
| Review Failure Reason Acquisition | A new AuditInfos field has been added to the response parameters of the message-sending APIs. When a message fails to send due to review failure, this field provides the detailed failure reason. |
Improvements
| Improvement | Description | Related API |
|---|---|---|
| Increased Mark Limit for Single Conversations | The maximum number of marks that a single conversation can have has been increased from 20 to 30. | Set Conversation Marks |
2024-10
Release date: 2024-10-15
New features
| Feature | Description | Method |
|---|---|---|
| Query user information on the server | ZIM supports querying user information on the server by user ID. The user information include user name, user avatar, and extended fields. | Query user information |
| Recall a room message on the server | ZIM supports recalling room messages on the server. | Recall a room message |
Enhancement
| Item | Description | Method |
|---|---|---|
| Enhancement of the server API response parameter for sending group messages | We have added a new response parameter MsgId for the server API SendGroupMessage, which can be used to locate messages. | Send Group Messages |
| Improvement of parameters of callback on message sent | When a message fails to send, the msg_id parameter in the callback on message sent will no longer be empty. | Callback on message sent |
| Retrieving the message extension field from the server | Through the payload parameter in the server callback on not sent yet, ZIM supports retrieving the extension field passed by users when sending messages. | Callback on not sent yet |
Increased length limit for ExtendedData in MessageBody | The default maximum length of ExtendedData in the MessageBody structure is 1 KB. If you need to increase it, please contact ZEGOCLOUD technical support. | MessageBody Introduction |
2024-08
Release date: 2024-08-02
New features
| Feature | Description | Related APIs |
|---|---|---|
| Conversation Marking | Supports users to mark conversations, suitable for scenarios where users need to pay attention to certain conversations or cannot handle certain conversations. This feature can be used to group conversations by setting the same mark for multiple conversations. | Set Conversation Marks |
| Sender Unaware When Sending Messages by Server APIs | Newly adds SenderUnaware field, allowing the client corresponding to the FromUserId (sender's user ID) in the request parameters to be unaware of the sending of the peer-to-peer message sent by the server. | Send a one-to-one message |
2024-05
Release date: 2024-05-31
New features
| Feature | Description | Method |
|---|---|---|
| Server-side management of call invitations | Supports initiating, accepting and rejecting call invitations on the server side. | |
| Server-side management muting | Supports muting groups and specific group members on the server. | |
| Server-side setting group member roles | Supports modifying group member roles on the server. | Set group member roles |
2024-03
Release date: 2024-03-29
New features
| Item | Description | Method |
|---|---|---|
| Server-side query session list | Supports paging query of the user's latest 1000 conversations (single chat and group chat) on the server side. | Query conversation list |
| Query historical messages on the server | Support paging query of the historical message list of the user-specified single chat or group chat session on the server. | |
| Modify group specifications on the server side | Support modifying the group's group entry verification mode, invitation mode, invitation target verification mode and upper limit of group members on the server side. | Modify group specification limit |
Enhancement
| Item | Description | Method |
|---|---|---|
| New parameters for server-side create group interface | Added CreateGroupTime parameter to support setting events for group creation. | Create a group |
| Added new parameters to the server-side interface for adding group members | Added the GroupMemberInfos parameter to support defining the group joining time and group joining mode of users who join the group. | Add group members |
2024-02
Release date: 2024-02-02
New features
| Item | Description | Method |
|---|---|---|
| Server-side Conversation Muting | Supports setting the mute notification status for group chat and one-on-one conversations on the server-side. | Mute notifications for conversations |
| Pin conversations on the server side | Supports setting the pinned status for user conversations on the server side. | Pin conversations to the top |
| Modify group information on the server side | Supports modifying the avatar, name, and announcement of a pinned group on the server side. Note: To use this feature, please contact the ZEGOCLOUD technical support team. | - |
| Manage friends on the server side | Supports adding and deleting friends for users, querying the friend list, checking friend relationships, and updating friend aliases and attributes. | |
| Manage blacklist on the server side | Supports batch blocking and unblocking users, querying the blacklist, and checking blacklist relationships for users. |
2024-01
Release date: 2024-01-05
New features
| Feature | Description | Method |
|---|---|---|
| Server-side message retraction | Supports calling the interface from the server to retract one-on-one messages and group chat messages. | |
| Server-side user profile modification | Supports calling the interface from the server to modify user profile information, including user nickname, avatar, etc. | Modify user information |
Enhancement
| Item | Description | Method |
|---|---|---|
| Added new response parameters to the server interface for sending one-to-one chat messages | Added the SuccessList parameter, with member parameters including UserId、MsgId and MsgSeq, to provide information about users who have successfully received the message. MsgSeq can be used for Recall a one-to-one message. | Send a one-to-one messages |
| Added new response parameters to the server interface for sending group chat messages | Added MsgSeq, which can be used to Recall a group message. | Send group messages |
| New field for server callback after the message is sent | Added user_list field, used to return messages in batches to receive user information. Warning: Only when developers call the server interface Send a one-to-one message, this field will have a value. | Callback on message sent |
2023-11
Release date: 2023-11-20
New features
| Feature | Description | Method |
|---|---|---|
| Server-Side API for adding group members | Supports adding specified users to a group. | Add group members |
| Server-side API for dismissing a group | Supports dismissing a specified group. | Disband a group chat |
| Server-side API for transferring group ownership | Supports transferring group ownership to a specified group member. | Transfer the group ownership |
| Server-side API for setting group member nickname | Supports setting the nickname for a specified group member. | Set nicknames of group members |
| Server-side message with receipt | When sending one-to-one messages or group messages through the server, you can attach a receipt to know if the message has been read. Supported message types include text, image, file, audio, video, and custom messages. For more details, please refer to MessageBody introduction. | |
| Server-Side login and logout callback | When a user logs in or logs out, the ZIM server will actively notify the developer's server through callbacks. | Login and logout callback |
| Offline push to all users | When using the server-side API for pushing messages to all users, you can choose the push type to achieve offline push. | Push message to all users |
Enhancement
| Item | Description | Method |
|---|---|---|
| Server callback for call creation | The server callback for call creation now includes the caller field, which indicates the user who initiated the call. For more details, please refer to Callback on call invitation sent. | - |
2023-10
Release date: 2023-10-26
New features
| Feature | Description | Method |
|---|---|---|
| Added support for server-Side signaling message types | Supports sending binary signaling messages encoded in base64 through the server. For more details, please refer to MessageBody introduction. | - |
2023-08
Release date: 2023-08-31
New features
| Feature | Description | Method |
|---|---|---|
| Sender unaware for server-side one-to-one messaging | Added the SenderUnaware field, which allows the client associated with the FromUserId(sender's user ID) to be unaware of the server-side one-to-one message being sent. | Send a one-to-one message |
| Sender aware for server-side room messaging | Added the SenderUnaware field, which allows the client associated with the FromUserId(sender's user ID) to be aware of the server-side room message being sent. | Send room messages |
| Server-side broadcast messaging | Supports sending messages with specific content, such as text and images, to all online users, including the message sender. This feature is suitable for scenarios like broadcasting announcements or displaying cross-room gift animations. | Push message to all users |
| Query whether the user is in the room | This interface supports querying whether a specified user is present in the target room. | Query whether a user is in a room |
2023-07
Release date: 2023-07-18
New features
| Feature | Description | Method |
|---|---|---|
| Get room member information | Supports calling server-side API to get information about room members based on room ID, including the number of users in the room, user IDs, and names. | Obtain information about users in a room |
| Server-side message sending API now supports more message types | Supports sending image, file, audio, video, custom, and barrage message types through the server-side API. For details, please refer to MessageBody introduction. |
2023-05
Release date: 2023-05-23
New features
| Feature | Description | Method |
|---|---|---|
| Pre-send message callback | By setting server-side callbacks, when users send one-on-one, group, or room chat messages, ZIM sends requests to the developer's server. Developers can implement:
| Callback on message not sent yet |
| Post-send message callback | By setting server-side callbacks, after users successfully or unsuccessfully send one-on-one, group, or room chat messages, ZIM sends requests to the developer's server. Developers can implement:
| Callback on message sent |
| Batch user registration | Supports calling server-side APIs to specify user information (user ID, etc.), allowing developers to register multiple users with a single request. Note: Supports registering up to 100 users at a time. | Batch register users |
| Query group list under an app | Supports calling server-side APIs to retrieve the IDs of all groups in the app. | Query group list in the app |
| Query group member list | Supports calling server-side APIs to specify the group ID and retrieve the member list of the corresponding group. | Query group member list |
| Remove group members | Supports calling server-side APIs to specify the group ID and user ID, and remove group members in batch. Note: Supports removing up to 50 group members at a time. | Remove group member |
2023-01
Release date: 2023-01-11
New features
| Feature | Description | Method |
|---|---|---|
| Added server callbacks related to call invitation | You can confirm the results of the call invitation via the server callbacks provided by In-app Chat, which suits the call invitations made in a weak network condition (results returned by the SDK can be volatile). |