Register

To register your application, you need to pass the License Key and UserIdentifier(Unique ID).

info

{api-base-url} can be obtained from the MirrorFly console.

Trial/Freemium Customers#

HTTP request#

curl -X POST "https://{api-base-url}/api/v1/sandbox/register"
-H "accept: */*"
-H "Content-Type: application/json"
-d "{\"deviceType\": \"web\",\"licenseKey\":\"XXXXXXXXXX\",\"userIdentifier\":\"99xxxxxx11\"}"

Request Params#

ParamDataTypeRequiredDescription
deviceTypeStringYesDevice Type is the info of Web Chat for API.
licenseKeyStringYesLicense Key is required to proceed with registration.
userIdentifierStringYesUser Identifier is a unique Id to Register the User.

Response#

If the user registration success, check the below response body.

{
"token": "XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
"username": "99xxxxxx11",
"password": "XXXXXXXXX", // Auto generated
"isExisting": true/false,
"isProfileUpdated": true/false,
"config": {
"domain": " ",
"videoLimit": 40,
"audioLimit": 60,
"recallTime": 60,
"privateTime": 1,
"xmppDomain": "XXXXXXXXX",
"xmppHost": "XXXXXXXXX",
"xmppPort": 1234,
"adminUser": "123456789",
"googleTranslate": "XXXXXXXXX",
"signalServerDomain": "XXXXXXXXX",
"notificationHelpUrl": null,
"sdkUrl": null,
"pinExpireDays": 31,
"pinTimeOut": 32,
"fileSizeLimit": 2000,
"stuns": [
"XXXXXXXXX"
],
"turns": [
{
"turn": "XXXXXXXXX",
"username": "99xxxxxx11",
"password": "XXXXXXXXX"
}
],
"liveStreamingSignalServer": "1",
"isLiveStreamingEnabled": false,
"sipcallEnabled": false,
"sipServer": null,
"callRoutingServer": "XXXXXXXXX",
"chatBackupType": null,
"chatBackupFrequency": null,
"xmppPortWeb": "1234",
"iv": "XXXXXXXXX",
"ivProfile": "XXXXXXXXX"
}
}

Error#

In the case of an error, an error object like below is returned.

{
"status": 400,
"message": "Error Message"
}

Subscribed Customers#

HTTP request#

curl -X POST "https://{api-base-url}/api/v1/register"
-H "accept: */*"
-H "Content-Type: application/json"
-d "{\"deviceType\": \"web\",\"licenseKey\":\"XXXXXXXXXX\",\"userIdentifier\":\"XXXXXXXXXX\"}" this should be pass like Encrypted Request data in key variable of "registerData".
Ex: -d {"registerData":"hTxLWElL+hIFZbKki+pvd8ag1zTOumHMjZpxR1zMkQtNimSQoRDqpr7kJonPeSZXWr/QDXIac4diHM/X52NSYtK3wHLXIBghXkFU0eITqr0uRhKqRV9+bwZbPp5Rrc8rCNyQsYiAoAOq5yxMf6zwwK+j/iv+qIrr0477PBNJNlRiXUndchmYj1G2En6ceKnO"}

Response#

If the user registration success, check the below encrypted response body.

{"status":200,
"data":"XrxlvqM5EnqPLBNBKY/Mbq1QvqUQ08nuKnIQ5IpILoniSBOjJQQ7cmmjlNMv9ttwsvYKVOJC2HCy5vWLX3MtQcQnJYGkK9CDuBt8tkCE4L+MsCiG/a6U2/Mu+gv3f8RiVGvTn0at6YMUYOu2kOkqgRbEvdSrpo8EWBsM0u7QENS6j5eZnd93iAKG7oI8zMCyK6Gj9GdvA30Tmw7pJ9HxWmDCflgJzNnWvtGvubMslixiO97AzH3koWS3VOkVDTWhW4nQ7/Z1Y1P9+Sz++Do78ZksVMxAyhuIApZfCTUp2h+KJ9hl7VkKr4XNY+LaQLRXXz6qZCcXJ4QUMGdh5t9hETsXGOXbIb0q2ve5DXmGWkuc3UF0rX4bI4CTSFZjFak/MASiLrVC374UqKvZV4LucSWQZ2fwGaPNiwdIWrn0hrgVg5QRBpqa0HVzOgVaJPElOE+JzAmTYhd6UrEJbUsL9wOdk2mPRhRMLsX9IViSwXoApKo7h18vvD0+GqbHhvLIqZ31nf0x3rwdPI1XqQ3NaJAVWVQM2DPAeuBv5MTJ00I9JQhyKTEnxiJJJGLAvvOM+7uQFyGfIcbULy2mQRlauW9MosdO5pig5U5o8W5vDgce5YRga8RS4vSodUiuJhyw5F6g92HP4mS6ix6E+qc37/lY+NTW4Gs038906aehka1CWYjcuxzO82HEM7Sqqky7KCdYhj4CrwiNhOsVdL8TMydJIJmAgtiwhaID7sg7SHdykrihSvBYmMJel3PHikGexO1rF0+w6h3oTsWldDrFH7zBiKHymVdjR20VN38M5mxXU/E4tZh1Q4RBwTNGWSdLnEb1FL57GKnRCxgltFhiVkL4Dy0N8/oNGXALEeRVBf0Zv0DxGFh9I3w6TKcx+3kNGMUA4Gha5WAvu5z+CoO22BupPJh7iWcX2K784ivFKIzeYP+PibnYStN1KRlXRMpOcxWZzfIFspn0AZxqu7HJyS9J1Pa/TyZwF/1E2nkh5Kt0itulzwlqPpVqmIJKX9v5MN1K4rJSaY+ejRwfXEz1lww/A3eKhnUc2hVxmOw70uz5E+OMm61sn3gVCG89WkOHbFizQkzEN/WoUrFUQgfM1EExl9PGftByGi4TgdNAqL6KebbaqEmmUkoIU86Xgw1VKn3DVA34hzXTPE2Rd3zpfgOS4rGjMggyE7+KLjj0Xc2ip8PB/jh9Y7KXZ1hnp7AWIknHKkQb1a7o7g5lBnR1cnTXH27X7rspt0BI2C5TaZBKKJg4a5fup1Yf20wDQhLyA6LfM8jFd+Bdcltot/lHDNfoULUuS25TNs91koRF69SLCm2P6x6JIZeu5jX2dzBbDHD9QHLCV71yTJA0VYFlTinJdKHCRkHtbNJLcxW0DNnP9jEsj9Gr5zV95kZUN124s/8hex+RTDq38y25QwSqt64IucuHC/nVhBaCrbNB08l9PLdGLIss4pBknCSxeo1r",
"message":"Data retrieved successfully"}