Let's integrate our SDK in few minutes

Getting started#

Download SDK Files

With Chat#

If you are already integrated the chat SDK in your application, then pass additional signalServer property with server URL in SDK.initializeSDK method.

signalServer: SIGNAL_SERVER_URL

Add the following callback listeners in callbackListeners property in SDK.initializeSDK method first argument object.

incomingCallListener,
callStatusListener,
userTrackListener,
muteStatusListener,
missedCallListener,
callSwitchListener,
inviteUsersListener,
mediaErrorListener,
callSpeakingListener,
callUsersUpdateListener,
callUserJoinedListener,
callUserLeftListener,
helper

Example#

callbackListeners:{
    ...chatCallbackListener,
    incomingCallListener,
    callStatusListener,
    userTrackListener,
    muteStatusListener,
    missedCallListener,
    callSwitchListener,
    inviteUsersListener,
    mediaErrorListener,
    callSpeakingListener,
    callUsersUpdateListener,
    callUserJoinedListener,
    callUserLeftListener,
    helper
}

Without Chat#

We should initialize the SDK.

Initialize SDK#

const initializeObj = {
  xmppSocketHost: `HOST`,
  xmppSocketPort: `PORT`,
  ssl: `SSL`,
  encryptKey: `ENCRYPT_KEY`,
  apiBaseUrl: `API_URL`,
  signalServer: `SIGNAL_SERVER_URL`,
  callbackListeners: {},
};
await SDK.initializeSDK(initializeObj);

Request Params#

Arguments	Description	Type	Required
xmppSocketHost	XMPP Socket Host Domain Name	String	true
xmppSocketPort	XMPP Socket Port Number	Number	true
ssl	SSL	Boolean	true
encryptKey	Message Encryption Key	String	true
apiBaseUrl	API Base URL for Backend	String	true
signalServer	Signal Server URL	String	true
callbackListeners	Check here for callback listerners	Object	true

Response Params#

Arguments	Description	Type
statusCode	Status Code	Number
message	Success/Error Message	String

Example Request#

const initializeObj = {
  xmppSocketHost: "domain",
  xmppSocketPort: 5281,
  ssl: true,
  encryptKey: "ddc0f15cc2c90fca",
  apiBaseUrl: "https://domain.com/api/v1",
  signalServer: "wss://domain.com",
  callbackListeners: {
    connectionListener,
    incomingCallListener,
    callStatusListener,
    userTrackListener,
    muteStatusListener,
    missedCallListener,
    callSwitchListener,
    inviteUsersListener,
    mediaErrorListener,
    callSpeakingListener,
    callUsersUpdateListener,
    callUserJoinedListener,
    callUserLeftListener,
    helper
  },
};
await SDK.initializeSDK(initializeObj);

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

Example Response#

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