Developer Docs | Kommunicate

Developer Docs | Kommunicate

  • Book a Demo
  • Try For Free

›Ionic/Cordova

Web

  • Installation
  • CMS Installation
  • Authentication
  • Conversation
  • Conversation Assignment
  • Customization
  • Localization
  • Logout
  • Troubleshooting

Android

  • Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Localization
  • Logout
  • Migration
  • Troubleshooting

iOS

  • Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Configuration
  • Localization
  • Logout
  • Troubleshooting

React Native

  • Installation
  • Expo Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Logout
  • Troubleshooting

Flutter Mobile

  • Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Localization
  • Troubleshooting

Flutter Web

  • Installation
  • Authentication
  • Conversation

Ionic/Cordova

  • Installation
  • Authentication
  • Push Notification
  • Conversation
  • Customization
  • Localization
  • Logout
  • Resolving Errors

Ionic/Capacitor

  • Installation
  • Authentication
  • Push notification
  • Customization

Rich Messages

  • How To Use
  • Types of Rich Messages

Bots

  • Bot setup
  • Dialogflow Integration
  • Lex Integration
  • Kompose Bot Builder
  • IBM Watson Integration
  • Custom Bot Integration
  • Import Kompose Bot
  • Bot Samples

Integrations

  • Zapier
  • WhatsApp
  • WhatsApp 360Dialog
  • WhatsApp Twilio
  • WhatsApp Cloud API
  • Instagram Integration
  • Telegram Integration
  • Sunshine Integration
  • Freshdesk Integration
  • Pipedrive Integration
  • Agile Integration

Platform APIs

  • Authentication
  • Endpoints

Dashboard Features

  • Analytics
  • Conversations
  • Users
  • Bot Integration
  • Helpcenter
  • Campaign Messaging
  • Settings

Configuration

  • Single Sign On (SSO) Setup
  • Webhooks
  • Access Token URL
  • Email Fallback

Conversation

Launch chat screen

You can open the chat screen by calling the below function:

Cordova

If you are using native Cordova:

kommunicate.launchConversation((response) => {
          //conversation launched successfully
        }, (response) => {
         //conversation launch failed
        });

Ionic

If you are using the ionic framework:

this.kommunicate.launchConversation()
   .then((response : any) => { /*sucessfully launched*/ })
   .catch((error : any) => { 
     /*error occurred*/
     console.log(error);
    });

Launch individual chat thread

You can open an individual chat thread by calling the below function and passing the clientChannelKey the clientChannelKey is which you got from a new conversation method on success response.

let convObj = {
        'clientChannelKey' : clientChannelKey, //pass the clientChannelKey here
        'takeOrder' : true //skip chat list on back press, pass false if you want to show chat list on back press
      };

Cordova

If you are using native Cordova:

kommunicate.launchParticularConversation(convObj, function(response) {
        //Conversation launched successfully
      }, function(response) {
        //Conversation launch failed
      });

Ionic

If you are using the ionic framework:

this.kommunicate.launchParticularConversation(convObj)
   .then((response : any) => { /*conversation sucessfully launched*/ })
   .catch((error : any) => { /*error occurred*/ });

Start a new Conversation

To start a new conversation first create a conversation object:

 let conversationObject = {
      'isSingleConversation' : false
     };

Then call the conversationBuilder function.

Cordova

If you are using native Cordova:

  kommunicate.conversationBuilder(conversationObject, (clientChannelKey) => {
     //The response will be a clientChannelKey which is used for launching a particular conversation.
     console.log("Kommunicate create conversation successful the clientChannelKey is : " + clientChannelKey);
    },(error) => {
      console.log("Kommunicate create conversation failed : " + error);
    });

Ionic

If you are using the ionic framework:

this.kommunicate.conversationBuilder(converationObject)
    .then((clientChannelKey: any) => console.log("Kommunicate create conversation successful the clientChannelKey is : " + clientChannelKey))
    .catch((error: any) => console.error("Error creating conversation." + error));

Create conversation for specific bots

If you have the list of agentIds and botIds, you can pass it in the below conversation object.

var conversationObject = {
     'isSingleConversation' : false,
     'agentIds':['<AGENT_ID>'],  //List of agentIds. AGENT_ID is the emailID used to signup on Kommunicate
     'botIds': ['<BOT_ID>']  //List of botIds. Go to Manage Bots(https://dashboard.kommunicate.io/bots/manage-bots) -> Copy botID
      };

Then call the conversationBuilder function.

Cordova

If you are using native Cordova:

  kommunicate.conversationBuilder(conversationObject, (clientChannelKey) => {
     //The response will be a clientChannelKey which is used for launching a particular conversation.
     console.log("Kommunicate create conversation successful the clientChannelKey is : " + clientChannelKey);
    },(error) => {
      console.log("Kommunicate create conversation failed : " + error);
    });

Ionic

If you are using the ionic framework:

this.kommunicate.conversationBuilder(converationObject)
    .then((clientChannelKey: any) => console.log("Kommunicate create conversation successful the clientChannelKey is : " + clientChannelKey))
    .catch((error: any) => console.error("Error creating conversation." + error));

Start a Unique Conversation

You can create a unique conversation using the below method. A unique conversation is identified by the list of agentIds and botIds used to create the conversation. If the same set of Ids are passed to the below method, then the already created conversation would be returned instead of creating a new conversation:

 var conversationObject = {
      'agentIds':['<AGENT_ID>'],  //List of agentIds. AGENT_ID is the emailID used to signup on Kommunicate
      'botIds': ['<BOT_ID>']  //List of botIds. Go to Manage Bots(https://dashboard.kommunicate.io/bots/manage-bots) -> Copy botID
       };

Then call the conversationBuilder function.

Cordova

If you are using native Cordova:

  kommunicate.conversationBuilder(conversationObject, (clientChannelKey) => {
     //The response will be a clientChannelKey which is used for launching a particular conversation.
     console.log("Kommunicate create conversation successful the clientChannelKey is : " + clientChannelKey);
    },(error) => {
      console.log("Kommunicate create conversation failed : " + error);
    });

Ionic

If you are using the ionic framework:

this.kommunicate.conversationBuilder(converationObject)
    .then((clientChannelKey: any) => console.log("Kommunicate create conversation successful the clientChannelKey is : " + clientChannelKey))
    .catch((error: any) => console.error("Error creating conversation." + error));

Note: Refer this if you want to use other paramters for creating the converstion, like metadata etc

Rich Message

Rich message provide a better overall conversational experience to the users, make the interface look pretty, they also drive more actions from your users and provide a good conversational experience. There are a variety of response types to choose from. For example, you can show images, play videos, provide buttons, list, forms, or card carousels.

Refer the following link to use rich messages in Kommunicate.

  • Rich Messages
← Push NotificationCustomization →
  • Launch chat screen
  • Launch individual chat thread
  • Start a new Conversation
  • Create conversation for specific bots
  • Start a Unique Conversation
  • Rich Message

Ready to automate more than 80% of your customer support?

Try for Free
  • support@kommunicate.io
  • United States
    (+1) (310) 402-2374
  • India
    (+91) 974-057-0196
  • Learn
    • iOS Chatbot
    • Amazon Lex Chatbot
    • Chatbot in Android
    • ChatGPT with Flutter
    • Document to Chatbot
    • React Native Chatbot
    • Create Flutter Chatbot
    • Whatsapp Business API
    • Integrate React Js Chatbot
    • Whatsapp Chatbot Using NodeJs
    • Integrate ChatGPT With Whatsapp
    • Integrate Dialogflow With Whatsapp
    • ChatGPT For Product Engagement
    • Product
    • AI Chatbot Builder
    • Generative AI Chatbot
    • Customer Experience
    • Chatbot Features
    • Dialogflow Integration
    • FAQ Chatbot
    • Live Chat
      Industries
    • Healthcare Chatbot
    • E-commerce Chatbot
    • Education Chatbot
    • Banking Chatbot
  • Integrations
    • E-commerce Chatbot Integration
    • Omnichannel Chatbot
    • Chatbot Integration
    • Chatbot for Website
    • Mobile Apps Chatbot
    • Chatbot for CRM's
    • Automation and Analytics
    • Zendesk Chatbot Integration
  • Resources
    • Chatbots Templates
    • Case Studies
    • Whitepapers
    • Chatbot Guide
    • Videos
    • Knowledge Hub
    • Comparisons
    • ROI Calculator
    • Blogs
    • Company
    • Partner Program
    • Affiliate Program
    • Pricing
    • About Us
    • Media
      Support
    • Contact Us
    • HelpCenter
    • Stack Overflow
    • API Status
  • Comapare
    • Kommunicate Vs Verloop
    • Kommunicate Vs Intercom
    • Kommunicate Vs Yellow
    • Kommunicate Vs Twak
    • Kommunicate Vs Ada
Arabic
Hindi
Spanish
French
German
Portuguese
Urdu
Software Advice Frontrunners for Live Chat Mar-22Software Advice Frontrunners for Live Chat Mar-22crozdesk badgeISO certificationHIPAA complianceGDPR compliant - GDPR Copy 12Created with Sketch.COMPLIANT
Copyright © 2025 Kommunicate.io.
T&C Privacy Policy Career SLA DPA Sitemap