Initialization

Initialize SDK#

const initializeObj = {
xmppSocketHost: `HOST`,
xmppSocketPort: `PORT`,
ssl: `SSL`,
encryptKey: `ENCRYPT_KEY`,
apiBaseUrl: `API_URL`,
licenseKey: `LICENSE_KEY`,
isSandbox: `SANDBOX_MODE`,
callbackListeners: {},
signalServer: `SIGNAL_SERVER`,
janusUrl: `JANUS_URL`,
};
await SDK.initializeSDK(initializeObj);

Request Params#

ArgumentsDescriptionTypeRequired
xmppSocketHostXMPP Socket Host Domain NameStringtrue
xmppSocketPortXMPP Socket Port NumberNumbertrue
sslSSLBooleantrue
encryptKeyMessage Encryption KeyStringtrue
apiBaseUrlAPI Base URL for BackendStringtrue
licenseKeyMirrorfly's License KeyStringtrue
isSandboxif true Sandbox Mode will be EnabledBooleanfalse
callbackListenersCheck here for callback listernersObjecttrue
signalServerSignal ServerStringfalse
janusUrljanus UrlStringfalse

Response Params#

ArgumentsDescriptionType
statusCodeStatus CodeNumber
messageSuccess/Error MessageString

Example Request#

const connectionListener = (res) => {};
const presenceListener = (res) => {};
const friendsListListener = (res) => {};
const userProfileListener = (res) => {};
const messageListener = (res) => {};
const replyMessageListener = (res) => {};
const favouriteMessageListener = (res) => {};
const groupProfileListener = (res) => {};
const groupMsgInfoListener = (res) => {};
const mediaUploadListener = (res) => {};
const blockUserListener = (res) => {};
const singleMessageDataListener = (res) => {};
const muteChatListener = (res) => {};
const archiveChatListener = (res) => {};
const adminBlockListener = (res) => {};
const initializeObj = {
xmppSocketHost: "xmpp-preprod-sandbox.mirrorfly.com",
xmppSocketPort: 5280,
ssl: true,
encryptKey: "ddc0f15cc2c90fca",
apiBaseUrl: "https://api-preprod-sandbox.mirrorfly.com/api/v1",
licenseKey: "XXXXXXXXXXXXXXXXX",
isSandbox: true,
signalServer: "https://signal-domain.com/",
janusUrl: "wss://domain.com",
callbackListeners: {
connectionListener,
presenceListener,
friendsListListener,
userProfileListener,
messageListener,
replyMessageListener,
favouriteMessageListener,
groupProfileListener,
groupMsgInfoListener,
mediaUploadListener,
blockUserListener,
singleMessageDataListener,
muteChatListener,
archiveChatListener,
adminBlockListener
},
};
await SDK.initializeSDK(initializeObj);

Note: Check the Callback Event Listener Section to learn more about callbacks

Example Response#

{
"statusCode": 200,
"message": "Success"
}