RoboMatic Documentation
X
- Introduction
- Getting Started
- Non-developers Guide
- Developers Guide
- Embedded Script
- API - REST
- API - Websocket
- Entities
- Entity Relations
- User Inputs
- Extractors
- Dynamic Entity Relations using Extractors
- Chatbot Outputs
- Output Groups
- RoboMatic Thoughts
- Abilities & Operations
- Short-term & Long-term Memory
- Insights
- RoboMatic Habits
- Chatbots' Intelligence
- Intelligence Marketplace
- Chatlogs
- Unsupervised Learning
- Third-party Integrations
- About RoboMatic
- Privacy Policy
- Terms & Conditions
- Technical Troubleshooting
- Frequently Asked Questions
- Known Issues
- Sentence Components
- Acceptance & Rejection Thoughts
- Short-term Thoughts
- Long-term Thoughts
- Inline Thoughts
- Users' Sessions Thoughts
- Constructive Thoughts
- Suggested Inputs
- RoboMatic Interjections
You can embed your chatbot in any website by simply placing the script below to a specific location in the web page.
<script type="text/javascript" src="https://robomatic.ai/api_web.php?cb=n&k=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"></script>
The script is using a secure websocket connection to communicate with the chatbot.
Mandatory Parameteres
cb
A number that indicates which chatbot ID to connect to.
k
A 30 characters secret API key to allow communicating with the selected chatbot.
Chatbot ID and API Key can be found from Manage Chatbots section, click "Manage" button next to the selected chatbot you want to connect to, Chatbot ID and API Key can be found as indicated below:
Optional Parameters
Optional Widget Parameters
w
Widget width (e.g. 10px, 10vw, 10%). Default is: 100%, if not set.
h
Widget height (e.g. 10px, 10vw, 10%). Default is: 200px, if not set.
float
If it's set to 1, the widget will be floating in a fixed position at the bottom right in which it can be dragged within the HTML page.
TopSL
An integer value that represents the maximum top limit (in pixels) in which the widget can be dragged while the page is scrolled down. Default is: 5, if it's not set.
This parameter only used when float parameter is set.
TopNoSL
An integer value that represents the maximum top limit (in pixels) in which the widget can be dragged while the page is not scrolled down. Default is: 5, if it's not set.
This parameter only used when float parameter is set.
Optional Chatbot Parameters
SessionID
A value set to force the chatbot remember specific user and conversation in case this value used before. If it wasn't used before, the chatbot will start a new session with this value.
Without this parameter, the chatbot will use a previously created session value from the browser's cookies. If there is no previous sessions, it will generate a random value that indicates the current session.
NoCookies
If this parameter is set with a value equals to 1, the chatbot will never check the browser cookies. Every user visiting the webpage from the same browser will be considered as new user unless SessionID parameter is set.
ChatSource
A string value set to categorize the conversations (sessions) between the chatbot and its users. It's used to identify the source of the conversations. Such as: web, desktop, mobile, website A, website B, mobile app A, mobile app B ...etc
Reference
A string value representing the entry point where the conversation started. It's mainly used for marketing purposes.
timezone
A string value setting the timezone of the conversation. Usually used for time based chatbot responses. Check The List of Supported Timezones. If not set, the chatbot's default settings is used.
You can customize the conversation intro by setting any of the following parameters:
out
A value contains chatbot's output string. Setting this variable will force the chatbot to output specific string.
hint
A value containing string to help user start a conversation. Setting this parameter will set an initial value in the chatbot input text after loading the dialog window.
OID
A value contains numbers separated with commas. Each number represents a chatbot output record. This will force the chatbot to look only in these records randomly for a possible response. If you used this parameter, you must set op parameter equals to out.
OGID
A value contains numbers separated with commas. Each number number represents a chatbot output group record. This will force the chatbot to look only for output records that belong to the specified output groups. Output group records are checked randomly. If you used this parameter, you must set op parameter equals to out.
respective
If this parameter is set with a value equals to 1, it will force the chatbot to check the output records or the output group records in a respective order. This parameter is only used when OID or OGID parameters are used.
intel
A value contains numbers separated with commas. Each number represent a chatbot Intelligence ID which will force the chatbot to detect inputs and respond with outputs that are found within the intelligence IDs set.
<script type="text/javascript" src="https://robomatic.ai/api_web.php?cb=n&k=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"></script>
The script is using a secure websocket connection to communicate with the chatbot.
Mandatory Parameteres
cb
A number that indicates which chatbot ID to connect to.
k
A 30 characters secret API key to allow communicating with the selected chatbot.
Chatbot ID and API Key can be found from Manage Chatbots section, click "Manage" button next to the selected chatbot you want to connect to, Chatbot ID and API Key can be found as indicated below:
Optional Parameters
Optional Widget Parameters
w
Widget width (e.g. 10px, 10vw, 10%). Default is: 100%, if not set.
h
Widget height (e.g. 10px, 10vw, 10%). Default is: 200px, if not set.
float
If it's set to 1, the widget will be floating in a fixed position at the bottom right in which it can be dragged within the HTML page.
TopSL
An integer value that represents the maximum top limit (in pixels) in which the widget can be dragged while the page is scrolled down. Default is: 5, if it's not set.
This parameter only used when float parameter is set.
TopNoSL
An integer value that represents the maximum top limit (in pixels) in which the widget can be dragged while the page is not scrolled down. Default is: 5, if it's not set.
This parameter only used when float parameter is set.
Optional Chatbot Parameters
SessionID
A value set to force the chatbot remember specific user and conversation in case this value used before. If it wasn't used before, the chatbot will start a new session with this value.
Without this parameter, the chatbot will use a previously created session value from the browser's cookies. If there is no previous sessions, it will generate a random value that indicates the current session.
NoCookies
If this parameter is set with a value equals to 1, the chatbot will never check the browser cookies. Every user visiting the webpage from the same browser will be considered as new user unless SessionID parameter is set.
ChatSource
A string value set to categorize the conversations (sessions) between the chatbot and its users. It's used to identify the source of the conversations. Such as: web, desktop, mobile, website A, website B, mobile app A, mobile app B ...etc
Reference
A string value representing the entry point where the conversation started. It's mainly used for marketing purposes.
timezone
A string value setting the timezone of the conversation. Usually used for time based chatbot responses. Check The List of Supported Timezones. If not set, the chatbot's default settings is used.
You can customize the conversation intro by setting any of the following parameters:
out
A value contains chatbot's output string. Setting this variable will force the chatbot to output specific string.
hint
A value containing string to help user start a conversation. Setting this parameter will set an initial value in the chatbot input text after loading the dialog window.
OID
A value contains numbers separated with commas. Each number represents a chatbot output record. This will force the chatbot to look only in these records randomly for a possible response. If you used this parameter, you must set op parameter equals to out.
OGID
A value contains numbers separated with commas. Each number number represents a chatbot output group record. This will force the chatbot to look only for output records that belong to the specified output groups. Output group records are checked randomly. If you used this parameter, you must set op parameter equals to out.
respective
If this parameter is set with a value equals to 1, it will force the chatbot to check the output records or the output group records in a respective order. This parameter is only used when OID or OGID parameters are used.
intel
A value contains numbers separated with commas. Each number represent a chatbot Intelligence ID which will force the chatbot to detect inputs and respond with outputs that are found within the intelligence IDs set.