Botstar
botstarBotStar is a comprehensive chatbot platform that enables businesses to design, develop, and train chatbots visually for Messenger and websites.
Acciones disponibles (9)
Cada acción es una operación que el agente puede ejecutar contra este conector. Haz clic en una acción para ver sus parámetros.
BotStar LiveChat onClose CallbackBOTSTAR_BOTSTAR_LIVECHAT_ON_CLOSEAcciónTool to register a callback when the chat window is closed. use after the widget is initialized. example prompt: "register an onclose handler that logs 'goodbye!' to the console."
BOTSTAR_BOTSTAR_LIVECHAT_ON_CLOSEAcciónTool to register a callback when the chat window is closed. use after the widget is initialized. example prompt: "register an onclose handler that logs 'goodbye!' to the console."
Parámetros de entrada
callback_codestringObligatorioJavaScript code to execute inside the onClose callback.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get BotStar Application IDsBOTSTAR_GET_BOT_APP_IDAcciónTool to retrieve the botstar application id (`appid`). use when initializing or reinitializing the live chat widget.
BOTSTAR_GET_BOT_APP_IDAcciónTool to retrieve the botstar application id (`appid`). use when initializing or reinitializing the live chat widget.
Parámetros de entrada
bot_idintegerInternal BotStar ID of the bot. If provided, only returns the matching bot's appId.
bot_namestringCase-insensitive name of the bot to filter by. Ignored if `bot_id` is provided. If neither is provided, returns all bots.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Livechat bootBOTSTAR_LIVECHAT_BOOTAcciónTool to reinitialize the live chat widget with provided data. use after initial load to reset or update widget configuration.
BOTSTAR_LIVECHAT_BOOTAcciónTool to reinitialize the live chat widget with provided data. use after initial load to reset or update widget configuration.
Parámetros de entrada
modestringenumDisplay mode of the widget.
livechatpopupinlinefullpageuserobjectUser data attributes to load or update. Unset fields will be ignored.
appIdstringObligatorioYour BotStar application ID.
blockstringID of the starting block in your chatbot flow to display next.
variablesobjectMap of custom variables (string keys) to string or number values.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Close BotStar Livechat WidgetBOTSTAR_LIVECHAT_CLOSEAcciónTool to hide the live chat window. use when the chat widget is configured in livechat or popup mode.
BOTSTAR_LIVECHAT_CLOSEAcciónTool to hide the live chat window. use when the chat widget is configured in livechat or popup mode.
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Livechat on openBOTSTAR_LIVECHAT_ON_OPENAcciónTool to register a callback when the chat window is opened. use after widget initialization.
BOTSTAR_LIVECHAT_ON_OPENAcciónTool to register a callback when the chat window is opened. use after widget initialization.
Parámetros de entrada
callbackstringObligatorioJavaScript callback function to execute when the chat window opens (e.g., `function() { /* ... */ }`).
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Livechat openBOTSTAR_LIVECHAT_OPENAcciónTool to show the live chat window. use after the widget has been bootstrapped with botstarapi('boot') to programmatically open the chat window (mode must be 'livechat' or 'popup').
BOTSTAR_LIVECHAT_OPENAcciónTool to show the live chat window. use after the widget has been bootstrapped with botstarapi('boot') to programmatically open the chat window (mode must be 'livechat' or 'popup').
Parámetros de entrada
Sin parámetros.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Livechat updateBOTSTAR_LIVECHAT_UPDATEAcciónTool to update user details on the current live chat session. use when you need to modify user profile attributes during an active conversation.
BOTSTAR_LIVECHAT_UPDATEAcciónTool to update user details on the current live chat session. use when you need to modify user profile attributes during an active conversation.
Parámetros de entrada
tagsstring[]Tags associated with the user. This will replace current tags.
emailstringUser's email address.
avatarstringURL to the user's avatar image.
genderstringenumUser's gender. Choose from 'male', 'female', or ''.
malefemaleuser_idstringUnique identifier for the user.
birthdaystringUser's birthday in 'YYYY-MM-DD' format.
last_namestringUser's last name.
first_namestringUser's first name.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Get BotStar Webview ParameterBOTSTAR_WEBVIEW_GET_PARAMETERAcciónTool to retrieve a parameter value passed from the botstar chatbot to the webview. use inside onchatbotready after your page loads in modal mode with bs:input meta tags.
BOTSTAR_WEBVIEW_GET_PARAMETERAcciónTool to retrieve a parameter value passed from the botstar chatbot to the webview. use inside onchatbotready after your page loads in modal mode with bs:input meta tags.
Parámetros de entrada
parameter_namestringObligatorioName of the parameter as defined in your HTML meta tag `bs:input:<dataName>`
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not
Webview send responseBOTSTAR_WEBVIEW_SEND_RESPONSEAcciónTool to send data from the webview back to the botstar chatbot. use when you need to transmit responses or custom outputs from an open webview.
BOTSTAR_WEBVIEW_SEND_RESPONSEAcciónTool to send data from the webview back to the botstar chatbot. use when you need to transmit responses or custom outputs from an open webview.
Parámetros de entrada
outputsobjectObligatorioObject of outputs where each key corresponds to a bs:output:<key> meta tag, and values must be string or number.
responsestringObligatorioAnything you want to respond back to the BotStar chatbot.
outlet_namestringObligatorioName of the outlet to send data through, requires a bs:outlet:<outletName> meta tag.
Parámetros de salida
dataobjectObligatorioData from the action execution
errorstringError if any occurred during the execution of the action
successfulbooleanObligatorioWhether or not the action execution was successful or not