imiconnect Developer Hub

Welcome to the imiconnect developer hub. You'll find all the resources to help you get started with imiconnect quickly. We are here to support you if you get stuck. Let's jump right in!

Get Started    API Reference

JavaScript SDK Quickstart Guide


The minimum requirements to use imiconnect JavaScript SDK are:


Apple Push Notification

An APNS certificate, to enable Push Notification services.

Google Push Notification

A FCM certificate, to enable Push Notification services.


  • A valid Google developer account
  • A valid iOS developer account
  • An active account on imiconnect platform

Configuration Tasks


If you are at a version of IMIconnect which is V4.0, kindly refer to this link to Configure an IMIconnect Web Application.

Download and Integrate JavaScript SDK in your Website

For more information, refer here

Code Integration

Here is a summary of the process required to implement RT.

  1. Include SDK
  2. Startup plugin
  3. Check if user is already registered.
  4. Register User
  5. Connect
  6. Register messageListener
  7. Create a Thread
  8. Send message using publishMessage

Code Sample

  1. Unzip the downloaded SDK and add contents to your project
  2. Import below files in the <head> tag
<script src="assets/js/jquery.min.js"></script>
    <script src=""></script>
    <script src=""></script>
    <script type="text/javascript" src="assets/js/mqttws31.js"></script>
    <script type="text/javascript" src="assets/js/aes.js"></script>
    <script type="text/javascript" src="assets/js/imi-environments.js"></script>
    <script type="text/javascript" src="assets/js/IMIClient.js"></script>


Here, sdk is in folder “assets”, please update to project specific location

In Browser Console, verify if the plugin is available by typing IMI. It should output this:

Follow below step to setup In-App Messaging

  1. Call plugin’s startup() method:


Refer Managing Assets for managing multiple assets and paths

  1. Check if user is already registered
  1. Else register user
            var userID = 1;
            var deviceID = userID + new Date().getTime(); //any random no.
            var deviceProfile = new IMI.ICDeviceProfile(deviceID, userID);
            var registerCallback = {
                onSuccess: (msg) => {
                onFailure: (err) => {
            IMI.IMIconnect.register(deviceProfile, registerCallback);
  1. Connect
    In registration onSuccess callback, add below code:
var messaging = IMI.ICMessaging.getInstance();
    if (!messaging.isConnected())
  1. Register Listener for in-app messaging
  var msgCallBack = {
            onConnectionStatusChanged: (statuscode) => {
                console.log('onConnectionStatusChanged to', statuscode);
            onMessageReceived: (message) => {
                console.log('onMessageReceived ', message);
        var messaging = IMI.ICMessaging.getInstance();
  1. Create a thread
createThread(title) {
        var title = title || "New Conversation";
        var thread = new IMI.ICThread();
        var messaging = IMI.ICMessaging.getInstance();
        messaging.createThread(thread, createThreadCallBack);
    createThreadCallBack = {
        onSuccess: (threadObj) => {
        onFailure: (err) => {

  1. Publish a message
var publishMessageCallback = {
  onSuccess: function (msg) {
    console.log("message sent", msg);
  onFailure: function (errormsg) {
    console.log("failed to send message", errormsg);
function publish() {
  var text = "Sample message text";
  var message = new IMI.ICMessage();
  var messaging = IMI.ICMessaging.getInstance();
  messaging.publishMessage(message, publishMessageCallback);

Updated 4 months ago

JavaScript SDK Quickstart Guide

Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.