Let's integrate our SDK in few minutes

Chat SDKs for Javascript#

With CONTUS MirrorFly Chat SDK for web, you can easily add real-time chat features to your client app within 30 minutes.

Through our client SDK, you can initialize and configure chat into your app with minimal efforts.


If you're looking for the fastest way to build your app’s UI with MirrorFly Chat SDK, you can use our sample apps. To get our sample apps, click here.

Supported browsers#

BrowserSupported versions
Edge13 or higher
Chrome16 or higher
Firefox11 or higher
Safari7 or higher

Things To Be Noted Before You Get Started#

SDK License Key#

Skip this part if you are already having your license key.

To integrate MirrorFly Chat SDK into your app, you will need a SDK License Key. The MirrorFly server will use this license key to authenticate the SDK in your application.

To get the License Key,#

Step 1: Register here to get a MirrorFly User account. Registration is subject to verification and would take up to 24 hours.

Step 2: Login to your Account

Step 3: Get the License key from the application Info’ section


Integrate Chat SDK into Your Javascript App#

CONTUS MirrorFly Chat for JavaScript, makes the in-app chat development process easy with all the essential messaging features

Since it’s the core of all the languages - Importing JavaScript into the application is the fundamental step to proceed further before using any language.

Integrate Using Npm package#


Install mirrorfly-sdk (https://www.npmjs.com/package/mirrorfly-sdk) npm package by using the below command

Step 1: Install Mirrorfly Sdk in your application

npm i mirrorfly-sdk

Step 2: Import the SDK into your application where you want

import * as SDK from "mirrorfly-sdk";

Integrate Using Sdk Files#


Skip this part if you are already installed the SDK using NPM.

Step 1: To download the files from the JavaScript SDKs, click on the Download button.

Download SDK Files

Step 2: Extract the files from the downloaded zip file and copy them into your application.

Step 3: Once the file has been copied, include the script file into your index.html

<script src="./index.js"></script>

Step 4: Now you have the SDK object available in your application to proceed further with initialization.

Step 5: Once, you have successfully got the SDK into your application. It’s time to go with your client’s preferred language implementation.

Initialize Chat SDK#

To begin with the initialization process of the chat SDK you are required to have certain data that responds to the changes in the connection status in the client's app.

Now, paste the license key on the licensekey param and use the below given method to pass these data through the SDK for further processing.


When you are in the trial mode, by default the sandbox servers will be used. After purchase it will be upgraded to dedicated server.

const initializeObj = {
licenseKey: `LICENSE_KEY`,
callbackListeners: {},
await SDK.initializeSDK(initializeObj);

Request Params#

licenseKeyMirrorfly's License KeyStringtrue
callbackListenersCheck here for callback listernersObjecttrue

Response Params#

statusCodeStatus CodeNumber
messageSuccess/Error MessageString

Create a User#

Register User#

Step 1: You can use the below given method to register a new user.

Step 2: Once you are registered, you will be provided with a username and password that you can utilize to make the connection with the server via connect method.

await SDK.register(`USER_IDENTIFIER`);

Request Params#

USER_IDENTIFIERUnique Id to Register the User. User identifier can only contain lowercase alphanumeric characters, hyphens (-), and underscores (_)Stringtrue
FORCE_REGISTERdefault value true provide true to force the old session logged out when the registered user has reached the maximum number of multiple-sessions or provide false to allow registration till the maximum no of multiple-sessions reachedBooleanfalse
registerMetaDataregisterMetaData is an optional parameter to provide MetaData of user. Maximum size is 3Objectfalse

Request Input for registerMetaData#

keyName of the KeyString
valueName of the valueString or Boolean or Number

If FORCE_REGISTER is false and if it reached the maximum no of multiple-sessions, then registration will not success and it will throw a 405 exception. Either FORCE_REGISTER should be true or one of the existing session need to be logged out to continue registration.


If you want to use your own Id, you can use the userJid in the registration response.

Response Params#

statusCodeStatus CodeNumber
messageSuccess/Error MessageString
dataUsername, Password, isProfileUpdated, isSandbox, userJidObject

Sample Response:#

statusCode: 200,
message: "Success",
data: {
username: "123456789",
password: "987654321",
isProfileUpdated: true,
isSandbox: true,
userJid: "1234567890@xmppdomain"

userJid is the unique id that allows you to connect with other users to send or receive messages.

Connect to MirrorFly Server#

Step 1: You can use the credentials that you have obtained while registration to make the connection with the server.

Step 2: Once you have created the connection successfully, you will be responded with an approval message as ‘statusCode of 200’ or else will get an execution error.

Step 3: With this you can also trace the connection status that you receive in connectionListener callback function.

Step 4: If you face any error while making a connection with the server, you will receive an error message with callback.

await SDK.connect(`USERNAME`, `PASSWORD`);

Request Params#


Response Params#

statusCodeStatus CodeNumber
messageSuccess/Error MessageString

Sample Response:#

message: "Login Success",
statusCode: 200

To learn more about all possible logins and profile related setup, go to Profile Section.

Preparing user jid#

To generate a JID for any user, use the below method.

const userJid = SDK.getJid(USER_NAME)
USER_NAMEunique username which we get from Register response.String

Send a Message#

Finally, to send a message to another user you can use the below given method,

await SDK.sendTextMessage({
toJid: "",
messageText: ""

Request Param#

toJidJID of the To User. username + "@" + xmppSocketHostJID Stringtrue
messageTextText Message BodyStringtrue

Response Params#

statusCodeStatus CodeNumber
messageSuccess/Error MessageString
dataObject of dataObject

Response Format:#

status code: "", // Number - status code
message: "", // String - Success/Error Message
chatType: "", // String - Chat Type - "chat"
createdAt: "", // String - Message Created Time
deleteStatus: "", // Number - Delete Status
favouriteBy: "", // String - Favourited By - User
favouriteStatus: "", //Number - Favourite status
fromUserId: "", // String - From User Id
fromUserJid: "", // String - From User Jid
metaData: {}, //Object - Meta data for the message
msgBody: {
mentionedUsersIds: [] // Array of mentioned users
message: "", // String - Message Body
message_type: "", // String - Message Type
nickname: "", // String - nick name
msgId: "", // String - Unique Message Id
msgType: "", // String - Message Type
publisherId: "", // String - user Id
timestamp: 1681185232000, // Number - TimeStamp - Milliseconds
toUserId: "", // String - toUser Id
toUserJid: "", // String - toUser Jid
topicId: "", //String - Topic id for the message

Receive a Message#

To receive a message from another user you must implement the messageListener function. It’s a function that will be triggered whenever you receive a new message or related event in one-to-one or group chat. Further to initialize the SDK, you need to add the below callback method during the process.

function messageListener(response) {
console.log("Message Listener", response);

To learn more on 'message listener callbacks,' see the Message Callback Event Listener Section