Let's integrate our SDK in few minutes
#
Quick Start#
Call SDKs for WebCONTUS MirrorFly Call SDK with its robust features and functionalities makes the integration more efficient and easy for every client’s app.
On client-side implementation, our call SDK allows you to initialize and configure the call easily. On server-side implementation, we ensure the most reliable infra-management services for the call within the app.
This guided documentation here demonstrates the process as how to install the call SDK in your app so that you can send and receive the messages without any interruption within a few simple steps.
note
CONTUS MirrorFly Call SDKs use the fastest way in action, to experience the same you must use our trial app to enhance your existing call app. So just download our sample app and make a start with your app development. Click here to download the sample app.
#
Supported browsersBrowser | Supported versions |
---|---|
Edge | 13 or higher |
Chrome | 16 or higher |
Firefox | 11 or higher |
Safari | 7 or higher |
#
Make a note of Below Points Before Making a Start#
PART I - SDK License KeyBefore moving forward with CONTUS MirrorFly Call SDK integration, it is necessary for an SDK to be authenticated by the MirrorFly server using the license key for further processing.
caution
Skip this part if you are already having your license key.
The below given is the process that needs to be followed to obtain a license key:
Step 1: Get started - Signup into MirrorFly Console page (https://console.mirrorfly.com/register) and create a free MirrorFly account
Step 2: While creating an account you can provide your basic details that includes your name, organization details, work email, and contact number
Step 3: As soon as you got into the account! You get access to move across the entire page on your MirrorFly account. Click on the ‘Overview page’ and get access to the license key as well as downloadable JavaScript SDK files to proceed further with integration process
Step 4: Copy the license key from the ‘Application info’ section
#
PART II - Integrate Call SDK into Your Web Appcaution
If you are already integrated the SDK, you can add only the adapter-latest.js
in your application.
CONTUS MirrorFly Call for JavaScript, makes the in-app call 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.
#
Call SDK Integration for JavascriptStep 1: To download the files from the JavaScript SDKs, click on the Download
button, that will take you to the top of this guided documentation page.
Step 2: Click on the given Download button
and 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
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.
#
Call SDK Integration for ReactStep 1: Include script file into your index.html
Step 2: Create a new file SDK.js in the project root and paste the below code,
Step 3: Import the SDK into your application
#
Call SDK Integration for Angularnote
Minimum Requirement Angular version 8.3.29
Step 1: Copy all the extracted files from the SDK
folder.
Step 2: Create a new folder inside your project's Root folder and paste all the copied files into it.
Step 3: Open your angular.json
and search for the property by navigating the buttons : build => options => scripts
.
Step 4: Here, you can find the array of scripts wherein you can add the relative file paths of respective downloaded SDK JS files.
Step 5: Now, add the below codes in the Root component (before @Component Decorator).
Step 6: Once you have added the SDK into Root component’s ngOnInit
, initialize our SDKs within angular's initialization method.
#
PART III - TerminologyThe below are the common keywords/terminologies used in SDKs with their descriptions
Keyword | Description |
---|---|
userId | Unique ID assigned for each user Ex: 12345678 (any alphanumeric). The below characters is not allowed in userId: U+0022 (") U+0026 (&) U+0027 (') U+002F (/) U+003A (:) U+003C (<) U+003E (>) U+0040 (@) userID should follow below specification: https://xmpp.org/extensions/xep-0106.html |
userJid | userID+@+domain of the chat server Ex. 12345678@xmpp.chatsystem.dev.contus.us |
groupJid | Unique ID assigned for each group Ex: group123456 (any alphanumeric). GroupJID = groupID +@mix.+domain of the chat server Ex: group123456@mix.xmpp.mirrorfly.dev.contus.us` |
#
Initialize Call SDKcaution
If you already initialized the SDK, you can add the below callback listeners to receive call related events.
To begin with the initialization process of the call 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.
note
You can find the sandbox server details in the further Sandbox section for testing purposes.
#
Request ParamsArguments | Description | Type | Required |
---|---|---|---|
apiBaseUrl | API Base URL for Backend | String | true |
licenseKey | Mirrorfly's License Key | String | true |
isTrialLicenseKey | if true Trial Mode will be Enabled | Boolean | false |
callbackListeners | Check here for callback listerners | Object | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
#
Sandbox Detailsnote
To learn more about callback listeners, go to the Callback Event Listener Section.
#
Example Response#
PART IV - Create a Usercaution
Skip this part if you are already integrated the register and connect method.
#
Register UserStep 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.
#
Request ParamsStatus | Description | Type | Required |
---|---|---|---|
USER_IDENTIFIER | Unique Id to Register the User | String | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
data | Username and Password | Object |
#
Sample Response:caution
username
is the unique id that allows you to connect with other users to send or receive messages.
#
Connect to MirrorFly ServerStep 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.
#
Request ParamsStatus | Description | Type | Required |
---|---|---|---|
USERNAME | Username | String | true |
PASSWORD | Password | String | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
#
PART V - Make a voice callInitiate a call by providing the callee’s user JID into the makeVoiceCall method. Once the call initiated successfully, a callStatusListener callback will be triggered and callee user call status will be received here.
caution
If One to one call feature is unavailable for your plan, then it will throw 403 exception
note
To generate your own or others JID using the unique username got in registration response, use the const userJid = SDK.getJid(USER_ID)
method.
#
Request ParamsParam | Description | Type | Required |
---|---|---|---|
[USER_JID ] | User JID | Array | true |
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
#
PART VI - Receive incoming callTo receive an incoming call, a incomingCallListener callback should already be registered in the callee’s client app. Whenever a user make call to a user, the callee user will receive the calling data in this callback.
#
Response ParamsArguments | Description |
---|---|
allUsers | JID's of the users in the call. |
callTime | Call intiated time in timestamp format. |
callType | Describe the audio or video call. |
groupId | Contain the group ID If the call is group call. Otherwise, the value will be NULL. |
roomId | Call room ID. |
status | Status of the call(calling, ringing, connecting, connected). |
toUsers | Array of User JID of callee users. |
userJid | User JID who intiated the call |
#
Answer a callTo answer a call use the answerCall method.
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |
#
End a callTo end a call use the endCall method.
#
Response ParamsArguments | Description | Type |
---|---|---|
statusCode | Status Code | Number |
message | Success/Error Message | String |