Conversation
Launch conversation
Kommunicate provides conversationBuilder function to create and launch conversation directly saving you the extra steps of authentication, creation, initialization and launch. You can customize the process by building the conversationObject according to your requirements.
To launch the conversation you need to create a conversation object. This object is passed to the conversationBuilder function and based on the parameters of the object the conversation is created/launched.
Launch conversation for visitor
If you would like to launch the conversation directly without the visiting user entering any details, then use the method as below:
let conversationObject = {
appId: '<Your-App-Id>'
};
KommunicateCapacitorPlugin.buildConversation(conversationObject).then((res) => {
console.log("Conversation builder success : " + JSON.stringify(res))
}).catch((error) => {
console.log("Conversation builder error : " + error)
});
Launch conversation for visitor with lead collection
If you need the user to fill in details like phone number, emailId and name before starting the support chat then launch the conversation with withPreChat flag as true. In this case you wouldn't need to pass the kmUser. A screen would open up for the user asking for details like emailId, phone number and name. Once the user fills the valid details (atleast emailId or phone number is required), the conversation would be launched. Use the function as below:
let conversationObject = {
appId: '<Your-App-Id>',
withPreChat: true
};
KommunicateCapacitorPlugin.buildConversation(conversationObject).then((res) => {
console.log("Conversation builder success : " + JSON.stringify(res))
}).catch((error) => {
console.log("Conversation builder error : " + error)
});
Launch conversation with existing user
If you already have the user details then create a KMUser object using the details and launch the conversation. Use the method as below to create KMUser with already existing details:
let kmUser = {
userId: "reytum", //unique userId
password: "reytum", //optional,
displayName: "Rey" //optional
imageLink: "" //optional
};
let conversationObject = {
appId: '<Your-App-Id>',
kmUser: JSON.stringify(kmUser)
};
KommunicateCapacitorPlugin.buildConversation(conversationObject).then((res) => {
console.log("Conversation builder success : " + JSON.stringify(res))
}).catch((error) => {
console.log("Conversation builder error : " + error)
});
Make sure to run the below commands after doing the code changes:
npm run build
npx cap sync
If you have a different use-case and would like to customize the conversation creation, user creation and conversation launch, you can use more parameters in the conversationObject.
Below are all the parameters you can use to customize the conversation according to your requirements:
| Parameter | Type | Description |
|---|---|---|
| appId | String | The APP_ID obtained from kommunicate dashboard |
| kmUser | KMUser | Optional, Pass the details if you have the user details, ignore otherwise. The details you pass here are used only the first time, to login the user. These login details persists until the app is uninstalled or you call log out. |
| withPreChat | boolean | Optional, Pass true if you would like the user to fill the details before starting the chat. If you have user details then you can pass false or ignore. |
| isSingleConversation | boolean | Optional(true by default), Pass true if you would like to create only one conversation for every user. The next time user starts the chat the same conversation would open, false if you would like to create a new conversation everytime the user starts the chat. True is recommended for single chat |
| metadata | Any | Optional. This metadata if set will be sent with all the messages sent from that device. Also this metadata will be set to the conversations created from that device. |
| agentIds | Array of String | Optional, Pass the list of agents you want to add in this conversation. The agent ID is the email ID with which your agent is registered on Kommunicate. You may use this to add agents to the conversation while creating the conversation. Note that, conversation assignment will be done on the basis of the routing rules set in the Conversation Rules section. Adding agent ID here will only add the agents to the conversation and will not alter the routing rules. |
| botIds | Array of String | Optional, Pass the list of AI agents you want to add in this conversation. Go to AI agents -> Manage AI agents -> Copy botID. Ignore if you haven't integrated any AI agents. You may use this to add any number of AI agents to the conversation while creating the conversation. Note that this has no effect on the conversation assignee, as the Conversation Rules set forth in the Dashboard will prevail. |
| conversationAssignee | String | Optional, Pass either the agentId or botId. The conversation created will skip the routing rules and will be assigned to this agent or AI agent. You also need to pass the agentId in agentIds array or botId in the botIds array, if you are using the conversationAssignee parameter |
| team ID | String | Optional, Pass this team ID so that the conversation created will skip the routing rules and will be assigned to this team. |
| clientConversationId | String | Optional, Pass the unique id using which you can recognize the conversation. For e.g If you have a shopping app and each order has its specific conversation, the orderId of the order can be used as a clientConversationId. In this case everyId will have its specific conversation. |
| conversationTitle | String | Optional, Pass the custom title for a conversation. Use this if you would like to display a custom title instead of the conversation assignee name. |
| createOnly | boolean | Optional. Pass true if you need to create the conversation and not launch it. In this case you will receive the clientChannelKey of the created conversation in the success callback function. |
| launchAndCreateIfEmpty | boolean | Optional. Pass true if you need to create the conversation only the first time. The conversation list will also appear to the user. |
Send data to AI agent platform
You can set the data you want to send to the AI agent platform by calling the updateChatContext method as below:
let chatContext = {
'key': 'value',
'objKey': {
'objKey1' : 'objValue1',
'objKey2' : 'objValue2'
}
};
KommunicateCapacitorPlugin.updateChatContext(chatContext).then((res) => {
console.log("Update chat context success : " + JSON.stringify(res))
}).catch((error) => {
console.log("Update chat context error : " + error)
});
}