This Drupal module encapsulates Kandy’s JS SDK and Restful APIs. Kandy is a product by GENBAND (www.genband.com) that utilizes WebRTC to enable peer to peer audio and video calls and chat. SMS and PSTN calling support will be added to this module in the near future.
With this module, you can enable video and audio calling between two users that are logged into your Drupal application.
Think of pages where you anticipate users collaborating with each other, possibly to discuss content on those pages. Your users could start a video call with other online users and enhance the collaboration experience. Home page: http://www.kandy.io/
Installation
- Install shortcode module https://www.drupal.org/project/shortcode
- Install Kandy module https://github.com/kandy-io/kandy-drupal
- At Configuration > Content Authoring > Text Formats, select one of them or add new text format then enable shortcode filter
- Uncheck auto Convert line breaks into HTML
- Configure all required options at Configuration > Content Authoring >kandy
- Synchronize and assign kandy user at Configuration > Content Authoring > kandy > Kandy User Assignment
- Create new content(basic page, article, or a new content types) with kandy shortcode syntax.
Settings:
Login to https://www.kandy.io, select one project and get the following information:
- API Key: Kandy API key of the selected project.
- Domain Secret Key: Domain Kandy API key of the selected project.
- Domain Name: Domain name of the selected project.
Below are default configuration:
- Javascript Library Url: https://kandy-portal.s3.amazonaws.com/public/javascript/kandy/2.2.1/kandy.js
- Jquery Reload: If you need to use kandy jquery library, set it to yes.
User assignment: help you synchronize kandy users from kandy server to your users system. Select your user and click edit button to assign(unassign) kandy user.
Live chat configuration: Live chat feature needs some configurations before using:
-
Configure "Excluded Kandy Users" in Kandy Settings page: these Kandy users will not be assigned to your users. They are reserved to live chat feature or some features in future. Each user separated by comma or whitespace.
-
Add Excluded Kandy Users to live chat feature: From Kandy configuration page, chose Live Chat Users tab, this page display your excluded users in previous step. You can assign a user to live chat feature by chosing from select box and click Save.
-
Add Live Chat Agent: From Kandy configuration page, click on Live Chat Agents Tab . You can add a user from your user system to assign him as a Live Chat Agent.
Style customization: help you edit kandy shortcode(video, voice, chat...) style. Select appropriate file(.css) then click edit them.
Script customization help you edit kandy shortcode(video, voice, chat...) script(add more behaviour). Select appropriate file(.js) then click edit them.
All support script callback:
window.loginSuccessCallback = function () {
//do something when you login successfully
}
window.loginFailedCallback = function () {
//do something when you login fail
}
window.callIncomingCallback = function (call, isAnonymous) {
//do something when your are calling
}
window.onCallCallback = function (call) {
//do something when you are on call
}
window.callAnsweredCallback = function (call, isAnonymous) {
//do something when someone answer your call
}
window.callEndedCallback = function () {
//do something when someone end your call
}
window.answerVoiceCallCallback = function (stage) {
//do something when you answer voice call
}
window.answerVideoCallCallback = function (stage) {
//do something when you answer video call
}
window.makeCallCallback = function (stage) {
//do something when you make call
}
window.endCallCallback = function (stage) {
//do something when you click end call button
}
window.presence_notification_callback =
function(userId, state, description, activity) {
//do something with status notification
}####Kandy components and shortcode syntax:
Kandy Video Button: Make a video call button component(video call)
[kandyVideoButton
class = "myButtonStyle"
id = "my-video-button"
incomingLabel = "Incoming Call..."
incomingButtonText = "Answer"
callOutLabel = "User to call"
callOutButtonText = "Call"
callingLabel = "Calling..."
callingButtonText = "End Call"
onCallLabel = "You are connected!"
onCallButtonText = "End Call"]
[/kandyVideoButton]Kandy Video: Make a video component (video call)
[kandyVideo
title = "Me"
id = "myVideo"
style = "width: 300px; height: 225px;background-color: darkslategray;"]
[/kandyVideo]Kandy Voice Button: Make a voice call button component (voice call)
[kandyVoiceButton
class = "myButtonStyle"
id = "my-video-button"
incomingLabel = "Incoming Call..."
incomingButtonText = "Answer"
callOutLabel = "User to call"
callOutButtonText = "Call"
callingLabel = "Calling..."
callingButtonText = "End Call"
onCallLabel = "You are connected!"
onCallButtonText = "End Call"
type = "PSTN"
callTo ="01234xxxxx"]
[/kandyVoiceButton]Kandy Status: Make a Kandy user status component (available, unavailable, awway, busy....). Kandy Status usually use with kandy address book component.
[kandyStatus
class = "myStatusStyle"
id = "myStatus"
title = "My Status"]
[/kandyStatus]Kandy Address Book: Make an address book component which list all friend in your contact.
[kandyAddressBook
class = "myAddressBookStyle"
id = "myContact"
title = "My Contact"
userLabel = "User"]
[/kandyAddressBook]Kandy Chat: Make a Kandy chat component which help you send instant message to your friend in contact.
[kandyChat
class = "myChatStyle"
id = "my-chat"
contactLabel = "Contacts"]
[/kandyChat]Kandy SMS: Make a Kandy SMS component which help you send sms message to a phone number.
[kandySms
class = "mySmsStyle"
id = "my-sms"
messageHolder = "Message..."
numberHolder = "Number..."
btnSendLabel = "Send"]
[/kandySms]Kandy LiveChat: Make a small widget to help you implement live chat, give your customers ability to chat with customer service agent.
[kandyLiveChat class="myLiveChat"][/kandyLiveChat]Kandy Co-browsing: Make a co-browsing component which help you share your browser screen with your friends.
[kandyCoBrowsing
class="myCoBrowsingStyle"
id ="co-browsing"]
[/kandyCoBrowsing]Kandy Voice Call
[kandyVoiceButton class="myButtonStyle" id="my-button"][/kandyVoiceButton]Kandy Voice Call PSTN
[kandyVoiceButton type= "PSTN" class= "myButtonStyle" id="my-button"]
[/kandyVoiceButton]Kandy Voice Call PSTN with number
[kandyVoiceButton type= "PSTN" callTo = "01234xxxx" class= "myButtonStyle"
id="my-button"][/kandyVoiceButton]Kandy Video Call: use a video call button and two video (myVideo and theirVideo id is required).
[kandyVideoButton class="myButtonStyle"][/kandyVideoButton]
[kandyVideo title="Me" id="myVideo"][/kandyVideo]
[kandyVideo title="Their" id="theirVideo"][/kandyVideo]Kandy Presence: use a kandystatus and kandy addressbook compobent
[kandyStatus class="myStatusStyle" id="myStatus"][/kandyStatus]
[kandyAddressBook class="myAddressBookStyle" id="myContact"][/kandyAddressBook]Kandy Chat:
[kandyChat class="myChatStyle" id="my-chat"][/kandyChat]Kandy Sms:
[kandySms class="mySmsStyle" id="my-sms"][/kandySms]Kandy LiveChat
[kandyLiveChat class="myLiveChat"][/kandyLiveChat]Kandy Co-browsing
[kandyCoBrowsing class="myCoBrowsingStyle" id ="co-browsing"][/kandyCoBrowsing]You can use kandy module anywhere in your code by following code:
Load Kandy Module
module_load_include('php', 'kandy', 'kandy_api');After load kandy module succucessfully you can use all support api:
1. Get kandy user data for assignment table
kandy_get_user_data();Return: kandy user object array
2. Get kandy domain access token
kandy_get_domain_access_token();Return: array
$result = array("success" => true,
"data" => "data",
"message" => '')
OR
$result = array("success" => false,
"data" => "data",
"message" => "message")3. Get the kandy domain
kandy_get_domain();Get kandy domain from kandy settings or remote server
Return: array
$result = array("success" => true,
"data" => "data",
"message" => '');
OR
$result = array("success" => false,
"data" => "data",
"message" => "message");4. List Kandy User from database/remote
kandy_list_users($type = KANDY_USER_ALL, $remote = false)Parameters:
$type(int) :
KANDY_USER_ALL: all kandy users from database/remote
KANDY_USER_ASSIGNED: all assigned kandy users from database/remote
KANDY_USER_UNASSIGNED: all unassigned kandy users from database/remote
$remote(boolean) :
If $remote = true, get kandy users from remote server(kandy server)
instead of from database(local). Default is false.Return: Kandy user object array
5. Get assigned kandy user by current user id(main_user_id)
kandy_get_assign_user($mainUserId)Parameters:
$mainUserId(int): normal user id(1, 2, 3....)Return kandy user object or null
6 Get kandy user by kandy user id(kandyUserId)
kandy_get_user_by_user_id($kandyUserId)Parameters:
$kandyUserId(int): kandy user id without domain(user1, user2....)Return kandy user object or null
7. Assign a normal user to kandy user
kandy_assign_user($kandyUserId, $mainUserId)Parameters:
$kandyUserId(string) : kandy user id without domain(user1, user2....)
$mainuserId(int): normal user id(1, 2, 3....)Return: true/false
8. Unassign a kandy user
kandy_unassign_user($mainUserId)Parameters:
$mainuserId(int): normal user id(1, 2, 3....)Return: true/false
9. Kandy User synchronization
Synchronize kandy user from remote server to local
kandy_sync_users()Return: array
$result = array(
'success' => true,
'message' => "Sync successfully"
);
OR
$result = array(
'success' => false,
'message' => "Error Data"
);
- Supported browser: Chrome
- Kandy Shortcode not working: check your kandy api key, domain secret key for your application at admin > config > content > kandy
- Jquery conflict: Set Jquery reload to true at admin > config > content > kandy
- Note:
- When you uninstall kandy module, make sure to delete the public folder: sites/default/files/kandy
- Select proper text format which enable shortcode filter.
- From Configuration > Content Authoring > Text Formats: Uncheck Limit allowed HTML tags to make sure Kandy shortcodes can display properly.
- Check provide menu link to make your content as a menu.
- Uncheck promoted to front end
- Uncheck Display author and date information.
- Close comment settings
- Shortcode only work with inline format