Xparo WebSocket API Documentation
=================================

The **Xparo WebSocket API** provides real-time communication with the Xparo server. This API allows you to send commands, receive responses, and interact dynamically with your chatbot using WebSockets.

WebSocket Connection URL
------------------------

To establish a WebSocket connection, use the following URL:

ws://127.0.0.1:8003/chatbot_api/<secret_key>/<project_key>/


Replace `<secret_key>` and `<project_key>` with your specific keys.

Connecting to the WebSocket API
-------------------------------

To connect to the WebSocket API, use a WebSocket client (e.g., JavaScript WebSocket API, Python `websockets` library). The connection will enable real-time communication with the Xparo chatbot server.

Example JavaScript Connection Code
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

.. code-block:: javascript

    const socket = new WebSocket('ws://127.0.0.1:8003/chatbot_api/<secret_key>/<project_key>/');

    socket.onopen = function(event) {
        console.log('WebSocket connection established');
    };

    socket.onmessage = function(event) {
        console.log('Received from server:', event.data);
    };

    socket.onclose = function(event) {
        console.log('WebSocket connection closed');
    };

    socket.onerror = function(error) {
        console.error('WebSocket error:', error);
    };

Commands Overview
-----------------

Once connected, you can send different commands through the WebSocket to interact with the chatbot and manage server settings. Below is a list of the available commands and their expected responses.

Command: Initialize API
~~~~~~~~~~~~~~~~~~~~~~~

- **Command**:

.. code-block:: json

    {
      "initialize_api": {}
    }

- **Description**: Initializes the API connection and retrieves the initial configuration and AIML data.
  
**Response Example:**

.. code-block:: json

    {
      "status": true,
      "title": "hello",
      "disc": "hi",
      "goal": "Basic",
      "rules": "",
      "api_key": "",
      "aiml": "<category node_id=\"xparo_m0l3k1peb13suxsj7dr\"><pattern>HI</pattern><template></template></category>",
      "maps": "",
      "Sets": "",
      "properties": "",
      "System": ""
    }

Command: Get Schedule
~~~~~~~~~~~~~~~~~~~~~

- **Command**:

.. code-block:: json

    {
      "xparo_get_schedule": {}
    }

- **Description**: Retrieves the current schedule of actions.
  
**Response Example:**

.. code-block:: json

    {
      "schedule_control": {}
    }

Command: Sync Configuration Files
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- **Command**:

.. code-block:: json

    {
      "xparo_sync_config": {}
    }

- **Description**: Retrieves all configuration file paths.

**Response Example:**

.. code-block:: json

    {
      "change_config": {
        "xparo_name": "hello"
      }
    }

Command: Save AIML Content
~~~~~~~~~~~~~~~~~~~~~~~~~~

- **Command**:

.. code-block:: json

    {
      "save_aiml": "aiml content here"
    }

- **Description**: Saves the provided AIML content to the server.

Command: Ask the Bot
~~~~~~~~~~~~~~~~~~~~

- **Command**:

.. code-block:: json

    {
      "ask_bot": "your question here"
    }

- **Description**: Sends a question to the bot and retrieves the response based on the saved AIML data.
  
**Response Example:**

.. code-block:: json

    {
      "message": {
        "bot_response": "let's check this thing on internet"
      }
    }

Command: Control Schedule
~~~~~~~~~~~~~~~~~~~~~~~~~

- **Command**:

.. code-block:: json

    {
      "xparo_schedule_control": {}
    }

- **Description**: Modifies the robot's schedule on the server.

Command: Delete Schedule
~~~~~~~~~~~~~~~~~~~~~~~~

- **Command**:

.. code-block:: json

    {
      "xparo_delete_schedule_control": {}
    }

- **Description**: Deletes the robot's schedule on the server.

Error Handling
--------------

Ensure you handle WebSocket errors correctly to maintain a stable connection and retry logic where necessary. Here's an example of handling common WebSocket errors:

.. code-block:: javascript

    socket.onerror = function(error) {
        console.error('WebSocket error:', error);
        // Implement reconnection logic here
    };

Conclusion
----------

This documentation provides an overview of how to connect and interact with the Xparo WebSocket API. Utilize these commands effectively to manage your AIML content, schedules, and chatbot interactions in real-time.




























































.. raw:: html

  <script async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js?client=ca-pub-3419029396694223" crossorigin="anonymous"></script>
  <ins class="adsbygoogle" style ="display:block; text-align:center;" data-ad-layout="in-article" data-ad-format="fluid" data-ad-client="ca-pub-3419029396694223" data-ad-slot="4772957983"></ins>
  <script>
    (adsbygoogle = window.adsbygoogle || []).push({});
  </script>

.. raw:: html

      <style>
      .wy-grid-for-nav {
         overflow-y: scroll;
         position: unset;
         }
      </style>
      <link rel="stylesheet" href="https://firebasestorage.googleapis.com/v0/b/xp-website-9b131.appspot.com/o/assets%2Fstyle.css?alt=media&token=8a62ee77-4eb9-4d42-bed4-4bf4c9d0ac6c">
      



.. raw:: html


      <div class="search-form">
         <div>
            <div class="sticky-menu-container">
               <div class="inner-menu closed">
               <div class="menu-list" style=
               " height: 100%;
                  list-style: none;
                  display: flex;
                  flex-wrap: wrap;
                  align-content: space-between;
                  margin: 0;
                  padding: 0;">
                  <li class="menu-item">
                     <a href="/" class="ripple" style="height: 55px;">
                     <img src="https://firebasestorage.googleapis.com/v0/b/xp-website-9b131.appspot.com/o/myicon.png?alt=media&token=21090ad0-daa3-4b1b-835e-8719c5618ac5" class="img-circle" alt="xparo" style="height: 50px; width: 50px; margin: 5px 65px;">
                     </a>
                  </li>
                  <li>
                     <h5 class="header__title text-center  " style="scale: 0.5; position:relative; left:-15%;  align-items: center;">X<span class="header__title--light">.P.A.R.O</span></h5>
                  </li>
                  <li class="menu-item">
                     <span class="item-icon">
                     <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-ui-radios-grid" viewBox="0 0 16 16">
                        <path d="M3.5 15a2.5 2.5 0 1 0 0-5 2.5 2.5 0 0 0 0 5zm9-9a2.5 2.5 0 1 0 0-5 2.5 2.5 0 0 0 0 5zm0 9a2.5 2.5 0 1 1 0-5 2.5 2.5 0 0 1 0 5zM16 3.5a3.5 3.5 0 1 1-7 0 3.5 3.5 0 0 1 7 0zm-9 9a3.5 3.5 0 1 1-7 0 3.5 3.5 0 0 1 7 0zm5.5 3.5a3.5 3.5 0 1 0 0-7 3.5 3.5 0 0 0 0 7zm-9-11a1.5 1.5 0 1 1 0-3 1.5 1.5 0 0 1 0 3zm0 2a3.5 3.5 0 1 0 0-7 3.5 3.5 0 0 0 0 7z" />
                     </svg>
                     </span>
                     <span class="item-text"><a href="/dashboard_app" class="ripple">Dashboard</a></span>
                  </li>
                  <li class="menu-item">
                     <span class="item-icon">
                     <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-graph-up-arrow" viewBox="0 0 16 16">
                        <path fill-rule="evenodd" d="M0 0h1v15h15v1H0zm10 3.5a.5.5 0 0 1 .5-.5h4a.5.5 0 0 1 .5.5v4a.5.5 0 0 1-1 0V4.9l-3.613 4.417a.5.5 0 0 1-.74.037L7.06 6.767l-3.656 5.027a.5.5 0 0 1-.808-.588l4-5.5a.5.5 0 0 1 .758-.06l2.609 2.61L13.445 4H10.5a.5.5 0 0 1-.5-.5"/>
                     </svg>
                     </span>
                     <span class="item-text"><a href="\analytics_home" class="ripple">Analytics</a></span>
                  </li>

                  <li class="menu-item">
                     <span class="item-icon">
                     <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-search" viewBox="0 0 16 16">
                        <path d="M11.742 10.344a6.5 6.5 0 1 0-1.397 1.398h-.001q.044.06.098.115l3.85 3.85a1 1 0 0 0 1.415-1.414l-3.85-3.85a1 1 0 0 0-.115-.1zM12 6.5a5.5 5.5 0 1 1-11 0 5.5 5.5 0 0 1 11 0"/>
                        </svg>
                     </span>
                     <span class="item-text"><a href="\all_blogs" class="ripple">Search</a></span>
                  </li>
               </div>
               </div>
               <div class="outer-button">
               <div class="icon-container">
                  <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 92 92" enable-background="new 0 0 92 92" xml:space="preserve" class="close-icon">
                     <path id="XMLID_732_" d="M70.7,64.3c1.8,1.8,1.8,4.6,0,6.4c-0.9,0.9-2,1.3-3.2,1.3c-1.2,0-2.3-0.4-3.2-1.3L46,52.4L27.7,70.7
               c-0.9,0.9-2,1.3-3.2,1.3s-2.3-0.4-3.2-1.3c-1.8-1.8-1.8-4.6,0-6.4L39.6,46L21.3,27.7c-1.8-1.8-1.8-4.6,0-6.4c1.8-1.8,4.6-1.8,6.4,0
               L46,39.6l18.3-18.3c1.8-1.8,4.6-1.8,6.4,0c1.8,1.8,1.8,4.6,0,6.4L52.4,46L70.7,64.3z" />
                  </svg>
                  <svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px" viewBox="0 0 16 16" enable-background="new 0 0 92 92" xml:space="preserve" class="arrow-icon">

                     <path id="XMLID_507_" fill-rule="evenodd" d="M2.5 12a.5.5 0 0 1 .5-.5h10a.5.5 0 0 1 0 1H3a.5.5 0 0 1-.5-.5zm0-4a.5.5 0 0 1 .5-.5h10a.5.5 0 0 1 0 1H3a.5.5 0 0 1-.5-.5zm0-4a.5.5 0 0 1 .5-.5h10a.5.5 0 0 1 0 1H3a.5.5 0 0 1-.5-.5z" />
                  </svg>

               </div>
               </div>
            </div>
         </div>


         <nav class="nav-hamburger" id="dashboard_btn_inner_content">
            <div class="lazy-typing-container">
               <div class="lazy-typewriter">
               <p>you are using XPARO BETA* version.</p>
               </div>
            </div>
         </nav>

         </div>

.. raw:: html


   <script>
   var isAnimating = false;
   var isOpen = false;
   var button = document.querySelector(".sticky-menu-container .outer-button");
   var menu = document.querySelector(".sticky-menu-container .inner-menu");
   var closeIcon = document.querySelector(".sticky-menu-container .outer-button .close-icon");
   var arrowIcon = document.querySelector(".sticky-menu-container .outer-button .arrow-icon");
   var menuItems = document.querySelectorAll(".sticky-menu-container .inner-menu > .menu-list > .menu-item");
   var itemTexts = document.querySelectorAll(".sticky-menu-container .inner-menu > .menu-list > .menu-item > .item-text");
   button.addEventListener("click", function() {
      if (isAnimating) return;
      this.classList.add("clicked");
      menu.classList.toggle("closed");

      if (isOpen) {
         closeIcon.classList.remove("show");
         closeIcon.classList.add("hide");
         arrowIcon.classList.remove("hide");
         arrowIcon.classList.add("show");
         menuItems.forEach(function(item) {
            item.classList.add("text-hides");
         });
         itemTexts.forEach(function(text, index) {
            setTimeout(function() {
               text.classList.remove("text-in");
            });
         });
         isOpen = false;
      } else {
         closeIcon.classList.remove("hide");
         closeIcon.classList.add("show");
         arrowIcon.classList.remove("show");
         arrowIcon.classList.add("hide");
         menuItems.forEach(function(item) {
            item.classList.remove("text-hides");
         });
         itemTexts.forEach(function(text, index) {
            setTimeout(function() {
               text.classList.add("text-in");
            }, index * 150);
         });
         isOpen = true;
         try {
            close_edit_popup_now();
         } catch {}
      }

   });

   button.addEventListener("animationstart", function(event) {
      isAnimating = true;
   });

   button.addEventListener("animationend", function(event) {
      isAnimating = false;
      this.classList.remove("clicked");
   });
   </script>