Find the answer you are looking for

Different actions to execute in SDK

  1. Maximize chat window: generates the maximized view of the chat window.
    1. ➡$aivo.chat.maximize();
  2. Open chat window: opens the chat window and hides the initiator. 
    1. ➡ $aivo.chat.open();
  3. Logout and close chat window: minimizes the chat window and ends the current session, deleting the chat history. Re-displays the chat launcher.
    1.  ➡ $aivo.chat.close();
  4. Close chat window (minimize): minimizes the chat window and redisplays the chat launcher. The chat history is not deleted, and the current session remains active.
    1. ➡$aivo.chat.minimize()
  5. Send a message to the user (as if sent by the bot): adds a message to the chat window, it is displayed as a message from the Bot
    1. ➡aivo.chat.addMessage("Hello customer, I'm AgentBot");
  6. Send a message to the bot(as if sent by the user): Adds a message to the chat window, which is displayed as a message sent by the user. 
    1. ➡ $aivo.chat.sendMessage("Hello, I need help");
    2. ➡ $aivo.chat.sendMessage("Hello, I need help", { hideUserMessage: true }); The optional parameter hideUserMessage:true hides the user's message in the chat window. However, if the user refreshes or reloads the page, the hidden message will be displayed in the chat history. 
    3. ➡ $aivo.chat.sendMessage("Hello, I need help", { hideUserMessage: false }); The optional parameter hideUserMessage:false displays the user's message in the chat window.
    4. ➡$aivo.chat.sendMessage("Hello, I need help", { resetBeforeSend: true }); The optional parameter resetBeforeSend: true internally ends the chat session before sending the message, causing the user id to change.
    5. ➡$aivo.chat.sendMessage("Hello, I need help", { resetBeforeSend: false }); The optional parameter resetBeforeSend: false does not end the chat session before sending the message.
  7. Hide chat launcher: hides the chat launcher if it is visible. It is important to clarify that the window must first be minimized or closed (through the "close" or "minimize" events); otherwise, it does not perform any action.
    1. ➡$aivo.launcher.hide();
  8. Show chat launcher: if the start button was previously hidden, it will be shown again through this event.
    1. ➡$aivo.launcher.show()
  9. Remove the chat launcher: permanently remove the launcher button. Therefore, to show it again, the Aivo script must be loaded again.
    1. ➡$aivo.launcher.remove();
  10. Hide the minimization bar on the mobile: This allows you to hide the minimization bar on the mobile.
    1. ➡// Show $aivo.launcher.hideSticky(false);
    2. ➡// Hide $aivo.launcher.hideSticky(true);
  11. Show or hide the close chat icon (X): show or hide the close chat icon (X) located in the upper right margin of the header.
    1. // show the icon $aivo.chat.showCloselcon(true);
    2. // hide the icon $aivo.chat.showCloselcon(false);
  12. Send to satisfaction survey: allows sending the satisfaction survey to the chat window. This will only work in cases where the survey is previously activated in the Aivo Platform and, in addition, there is an interaction with the bot. 
    1. ➡$aivo.chat.closeToSurvey();
  13. End session without minimizing the chat window: ends the current session, deleting the chat history, without minimizing the window. Displays the chat initiator again.
    1. ➡$aivo.chat.resetWindow()
  14. Prevents the display of messages older than the time limit set by the 'hours' parameter in the window's chat history. That is, after X number of hours, old messages will be hidden. This parameter can be an integer or a decimal number. The calculation of the time elapsed since the message was sent is carried out taking into account the browser settings of the window user and their time zone.
    1. ➡$aivo.chat.cleanUpChatHistory(hours)
  15. Set the aesthetics and functionality of the chat window for applications: When running this command, the window will not display the maximize, minimize, or close icons. It will also not be draggable, and on mobile devices, it will occupy 100% of the available width and height.
    1. ➡ $aivo.chat.embed();
  16. Close Webview: closes the webview that is currently open in the app. This command will only take effect if a Webview is open during execution.
    1. ➡$aivo.chat.closeWebview();
  17. Check if a Webview is open in the application: When running the command, if it returns true, it indicates that a Webview is currently open; if it returns false, it indicates that it is not.
    1. ➡$aivo.chat.isWebviewOpen();
This website stores cookies on your computer. These cookies are used to collect information about how you interact with our website and allow us to remember you. We use this information in order to improve and customize your browsing experience and for analytics and metrics about our visitors both on this website and other media. To find out more about the cookies we use, see our Privacy Policy.

If you decline, your information won’t be tracked when you visit this website. A single cookie will be used in your browser to remember your preference not to be tracked.