Messenger - JS API Methods

Salesmate provides you small JavaScript API methods for your website to help you control and customize your messenger widget behavior.

Methods

login

This method will initiate the Salesmate messenger with the information provided by you as a form of an object. You can call this method in the situation where contact/visitor is not logged in when the page is loaded.

SALESMATE.login({ 
user_id: '<< user id | string | We recommend to pass user's email id to generate unique key >>', 
email: '<< email | string | pass a valid email address >>',
first_name: '<< first name of contact | string >>',
last_name: '<< last name of contact | string >>',
});

Example:

SALESMATE.login({ 
user_id: 'john.doe@example.com', 
email: 'john.doe@example.com',
first_name: 'John',
last_name: 'Doe',
});

logout

This method clears the Salesmate messenger session of the contact/visitor. You should call this method when the user logs out from your application. Otherwise, the cookies will keep tracking new events for the user who was logged in before from the specific machine.

SALESMATE.logout();

hideChatWidget

This method hides the messenger if it's open. It will not hide the messenger launcher button.

SALESMATE.hideChatWidget();

showChatWidget

This method shows the messenger. It will try to open messenger's last available state; otherwise, it will open the home screen.

SALESMATE.showChatWidget();

showMessages

This method opens up Salesmate messenger and displays the conversation list.

SALESMATE.showMessages();

showNewMessage

This method opens up Salesmate messenger and displays the screen to start a new conversation. Also if you provide a message as a parameter then the editor will come up preloaded with your message.

SALESMATE.showNewMessage();
or
SALESMATE.showNewMessage('Hello there');

trackEvent

This method helps you to track new events which visitor/contact performs on your website. You can also add further information to this event which will be visible inside your Salesmate app. Read more about how to track events inside Salesmate.

SALESMATE.trackEvent('your_event_name',{});

displayLauncher

This method is used to hide or show the launcher button on your website. If you need to hide or show the launcher on some specific pages of your site then this method can be used.

SALESMATE.displayLauncher(false);

customLauncherSelector

This method enables you to define any custom id or class of the HTML elements where, if your website visitor clicks then it will open the messenger launcher.

SALESMATE.customLauncherSelector('#id_name'); or SALESMATE.customLauncherSelector('.class_name');

Event Listeners

SALESMATE_ON_WIDGET_HIDE

You can listen to the messenger widget's hide event and execute additional code on your website.

window.addEventListener('SALESMATE_ON_WIDGET_HIDE', function() {...} );

SALESMATE_ON_WIDGET_SHOW

You can listen to the messenger widget's show event and execute additional code on your website.

window.addEventListener('SALESMATE_ON_WIDGET_SHOW', function() {...} );

SALESMATE_ON_WIDGET_COUNT_CHANGE

You can listen to the messenger widget's show event and execute additional code on your website.

window.addEventListener('SALESMATE_ON_WIDGET_COUNT_CHANGE', function() {...} );