In-app Chat
  • iOS : Objective-C
  • Android
  • macOS
  • Windows
  • Web
  • Flutter
  • React Native
  • Introduction
    • Overview
    • Basic concepts
  • Sample app
  • Getting started
  • Client SDKs
    • SDK downloads
    • Release notes
  • Guides
    • Authentication
    • Manage users
    • Room
    • Group
    • Messaging
    • Call invitation (signaling)
    • Manage sessions
  • Offline push notifications
  • Error codes
  • Server APIs
  • API Documents

Release notes

Last updated:2022-07-29 11:44

Version 2.2.0

Release date: 2022-07-29

New features

Feature Description Method
Change username Supports changing usernames.
Query user profile Supports users to query profiles, such as username, and status updates.
Query the number of group members Supports querying the number of group members. queryGroupMemberCountByGroupID

Version 2.1.5

Release date: 2022-06-15

New features

Feature Description Method
Content moderation Supports moderating the text messages, and images in one-on-one, group, and room chat. The mechanism can help moderate the following inappropriate content: Sex solicitation, terrorism, violence, advertisements, and more.


Known issues fixed.

Version 2.1.0

Release date: 2022-05-13

New features

Feature Description Method
Send & Receive rich media content Supports sending and receiving messages of different rich media types, such as images, audio, video, and files.
Automatic room creation When entering a room, supports automatic room creation when the room does not exist. enterRoom


Item Description Method
Member property of ZIMMessage enhanced The member property of the ZIMMessage object is changed to read-only. This property doesn't need to be concerned or modified when sending messages. ZIMMessage

Version 2.0.0

Release date: 2022-03-25

New features

Feature Description Method
Session management
  • Supports updating, searching, and deleting the session list.
  • Supports obtaining the session list to display all sessions and implementing a real-time message list.
Group chat
  • Supports creating a group chat, ungroup, joining, and leaving a group chat.
  • Supports transferring the group ownership, setting group notice, and more.
Offline notifications
  • Supports caching the one-to-one or group messages you sent when the receiver is offline. The receiver will get the message when back online.
  • Supports sending offline notifications to the client. We now support Apple, Huawei, Xiaomi, Vivo, Oppo, and more.
Message management
  • Supports saving the one-to-one, group, in-room messages on the local database for retrieval after changing your devices or getting back from offline status.
  • Supports deleting specified or all one-to-one or group messages.
Call invitation
  • Supports sending and responding to call invitations.
  • Suitbale for multiple scenarios, such as, video calls, send seat-taking invitation in live audio room, and more.


In this iteration, we unified and optimized all existing and new methods of In-App Chat In terms of style. When you upgrade the API methods from V 1.x.x to V 2.0.0, you will need to adjust the code accordingly by referring to the table below.

Item Description Method
Enhanced API method name
The method used to create the ZIM SDK instance: Changed to createWithAppID from create.
The method used to log in: Changed to loginWithUserInfo from login.
The method used to query room members: Changed to queryRoomMemberListByRoomID from queryRoomMember.
The method used to query online room members: Changed to queryRoomOnlineMemberCountByRoomID from queryRoomOnlineCount.
New parameter added for API method or callback
The method used to send one-to-one/group messages: a config parameter is added, used to set offline notifications, message priority, and more.
A roomID parameter is added for some method callbacks. It is convenient for you to get the roomID from which the result of the current operation comes when calling relevant methods.
The roomID and errorKeys parameters are added. It is convenient for you to get the roomID from the current operation result when they get the room property, and the key will be returned to you when the operation fails.