Web API

Además de ser capaz de integrar el chat de bots en su propio sitio web, y el acceso a ellos desde cualquier dispositivo Android o iOS, usted puede también tener acceso a su chat de bots a través del Robot Libre API web. La API de web te ofrece la ventaja de tener el control total de tu bot de la interfaz de cliente.

Puede utilizar la API de web para acceder a su bot desde tu propio sitio web mediante JavaScript, PHP o cualquier otro lenguaje. También puede utilizar la API de web para crear tu propia aplicación móvil para acceder a su bot, tales como Android o iOS de la aplicación.

Una API de web, es un conjunto de HTTP GET/POST URI que permiten el envío y recepción de mensaje de datos. Cuando usted navega por un sitio web, el navegador hace una serie de HTTP GET/POST de peticiones de URIs que devolver el contenido HTML. En un servicio web de la Uri devolver XML o JSON de datos, en lugar de contenido HTML.

El Bot Libre en la web de la API proporciona tres Api REST en uno. El primero es un conjunto de GET de HTTP URIs que tomar los datos del FORMULARIO, y devolver datos XML. El segundo conjunto de API de tomar POST de HTTP de datos XML, y devolver datos XML. El tercer conjunto de API de tomar POST de HTTP de datos JSON, y devolver los datos JSON.

La mayoría de las aplicaciones se usa el XML POST de la API, pero en algunas aplicaciones puede elegir utilizar el FORMULARIO de OBTENER la API, debido a su simplicidad. Las APIs son idénticos a otros de su mecanismo.

Test

Chat API URL Extremos

URL	Operation	Type	Description
/rest/api/form-chat	GET	Form	Send a chat message to a bot.
/rest/api/chat	POST	XML	Send a chat message to a bot.
/rest/json/chat	POST	JSON	Send a chat message to a bot.

El usuario de la API URL Extremos

URL	Operation	Type	Description
/rest/api/form-check-user	GET	Form	Validates and returns the user's details.
/rest/api/check-user	POST	XML	Validates and returns the user's details.

Bot API URL Extremos

URL	Operation	Type	Description
/rest/api/get-bots	POST	XML	Returns all bots.
/rest/api/get-bot-script-source	POST	XML	Get the source of the script.
/rest/api/delete-bot-script	POST	XML	Delete a script from a bot.
/rest/api/import-bot-script	POST	XML	Import a script bot.
/rest/api/import-bot-log	POST	XML	Import a log of a bot.
/rest/api/save-bot-avatar	POST	XML	Choose an avatar and save for a bot.
/rest/api/save-bot-script-source	POST	XML	Choose a script and save for a bot.
/rest/api/create-bot-attachment	POST	XML
/rest/api/up-bot-script	POST	XML	Move up the bot script
/rest/api/down-bot-script	POST	XML	Move down the bot script.
/rest/api/get-instances	POST	XML	Get all instances.
/rest/api/get-instance-users	POST	XML	Get instance users.
/rest/api/get-instance-admins	POST	XML	Get instance admins.
/rest/api/get-all-instances	POST	XML	Queries the details for all bot instances.
/rest/api/check-instance	POST	XML	Validates a bot ID or name exists, and returns the details.
/rest/api/form-check-instance	GET	Form	Validates Bot ID, and returns the bot's details.
/rest/api/form-get-all-instances	GET	Form	Queries the details for all bot instances.
/rest/api/update-instance	POST	XML	Update contents of bot instance.
/rest/api/update-instance-icon	POST	XML	Update to change the bot instance icon.
/rest/api/create-instance	POST	XML	Create a new bot instance
/rest/api/delete-instance	POST	XML	Delete bot instance.
/rest/api/flag-instance	POST	XML	Flag a bot instance.
/rest/api/star-instance	POST	XML	Star a bot instance.
/rest/api/train-instance	POST	XML	Train a chat bot instance.
/rest/api/thumbs-up-instance	POST	XML	Thumbs up a chat bot instance.
/rest/api/thumbs-down-instance	POST	XML	Thumbs down a chat bot instance

Puntos finales de URL de la API de chat en vivo

URL	Operation	Type	Description
/rest/api/get-channel-bot-mode	POST	XML	Get channel bot mode.
/rest/api/save-channel-bot-mode	POST	XML	Save channel bot mode.
/rest/api/create-channel-attachment	POST	XML	Create a channel attachmemt
/rest/api/create-channel	POST	XML	Create channel.
/rest/api/update-channel	POST	XML	Update channel.
/rest/api/get-bot-channel	POST	XML	Get bot channel.
/rest/api/get-user-channel	POST	XML	Get user channel.
/rest/api/get-channels	POST	XML	Retrieve all channels.
/rest/api/get-channel-users	POST	XML	Get all users of a selected channel.
/rest/api/get-channel-admins	POST	XML	Get all admins of a channel.
/rest/api/update-channel-icon	POST	XML	Update the icon of the channel.
/rest/api/thumbs-up-channel	POST	XML	Thumbs up a channel.
/rest/api/thumbs-down-channel	POST	XML	Thumbs down a channel.
/rest/api/flag-channel	POST	XML	Flag a channel.
/rest/api/star-channel	POST	XML	Star a channel channel.
/rest/api/delete-channel	POST	XML	Delete channel.
/rest/api/check-channel	POST	XML	Check to validate and returns a channel.

Foro de la API URL Extremos

URL	Operation	Type	Description
/rest/api/get-forums	POST	XML	Retrieve the forums.
/rest/api/get-forum-posts	POST	XML	Retrieve the posts of a forum.
/rest/api/get-forum-users	POST	XML	Get users of a forum.
/rest/api/get-forum-admins	POST	XML	Get admins of a forum.
/rest/api/save-forum-bot-mode	POST	XML
/rest/api/get-forum-bot-mode	POST	XML
/rest/api/create-forum	POST	XML	Create a new forum.
/rest/api/create-forum-attachment	POST	XML	Create an attachment for a forum.
/rest/api/create-forum-post	POST	XML	Create a new post for a forum
/rest/api/update-forum	POST	XML	Update the contents of the forum.
/rest/api/update-forum-post	POST	XML	Update the content of a post of a forum.
/rest/api/update-forum-icon	POST	XML	Update the icon of the forum.
/rest/api/check-forum	POST	XML	Check to validate and returns a forum.
/rest/api/check-forum-post	POST	XML	Check the post of the forum to validate and returns a post of a forum.
/rest/api/delete-forum	POST	XML	Delete a forum.
/rest/api/delete-forum-post	POST	XML	Delete a post of a forum.
/rest/api/flag-forum	POST	XML	Flag a forum.
/rest/api/flag-forum-post	POST	XML	Flag a post of a forum.
/rest/api/thumbs-up-forum	POST	XML	Placing a thumbs up to a forum.
/rest/api/thumbs-down-forum	POST	XML	Placing a thumbs down to a fourm.
/rest/api/subscribe-forum	POST	XML	Subscribe to a forum.
/rest/api/unsubscribe-forum	POST	XML	Unsubscribe to a forum.
/rest/api/star-forum	POST	XML	Placing a star to a forum.

Secuencia de comandos de la API URL Extremos

URL	Operation	Type	Description
/rest/api/get-scripts	POST	XML	Retrieve the scripts.
/rest/api/get-script-users	POST	XML	Get users of a script.
/rest/api/get-script-admins	POST	XML	Get admins of a script.
/rest/api/create-script	POST	XML	Create a new script.
/rest/api/update-script	POST	XML	Update the contents of the script.
/rest/api/update-script-icon	POST	XML	Update the icon of the script.
/rest/api/check-script	POST	XML	Check to validate and returns a script.
/rest/api/delete-script	POST	XML	Delete a script.
/rest/api/flag-script	POST	XML	Flag a script.
/rest/api/thumbs-up-script	POST	XML	Placing a thumbs up to a script.
/rest/api/thumbs-down-script	POST	XML	Placing a thumbs down to a script.
/rest/api/star-script	POST	XML	Placing a star to a script.

Avatar API URL Extremos

URL	Operation	Type	Description
/rest/api/get-avatars	POST	XML	Retrieve all avatars.
/rest/api/get-avatar-users	POST	XML	Retrieve all users of an avatar.
/rest/api/get-avatar-admins	POST	XML	Retrieve all admins of a selected avatar.
/rest/api/get-avatar-media	POST	XML	Retrieve the media of an avatar.
/rest/api/create-avatar	POST	XML	Create a new avatar.
/rest/api/create-avatar-media	POST	XML	Create a media for an avatar.
/rest/api/save-avatar-media	POST	XML	Save the media of an avatar.
/rest/api/save-avatar-background	POST	XML	Save the background image of an avatar.
/rest/api/delete-avatar	POST	XML	Delete an avatar.
/rest/api/delete-avatar-media	POST	XML	Delete a media of an avatar.
/rest/api/delete-avatar-background	POST	XML	Delete a background image of an avatar.
/rest/api/check-avatar	POST	XML	Validate an avatar and return it back to the user.
/rest/api/avatar-message	POST	XML	Avatar Message.
/rest/api/star-avatar	POST	XML	Placing a star to an avatar.
/rest/api/flag-avatar	POST	XML	Flag an avatar.
/rest/api/init-avatar	POST	XML
/rest/api/update-avatar	POST	XML	Update the contents of an avatar.
/rest/api/update-avatar-icon	POST	XML	Update the avatar icon.
/rest/api/thumbs-up-avatar	POST	XML	Placing a thumbs up to an avatar.
/rest/api/thumbs-down-avatar	POST	XML	Placing a thumbs down to an avatar.

Dominio de la URL Extremos

URL	Operation	Type	Description
/rest/api/get-domains	POST	XML	Get all available domains.
/rest/api/get-domain-users	POST	XML	Get all users of a selected domain.
/rest/api/get-domain-admins	POST	XML	Get all admins of a domain.
/rest/api/get-domain	POST	XML	Return a domain.
/rest/api/get-domain-icon	POST	XML	Return an icon of a domain.
/rest/api/create-domain	POST	XML	Create a new domain.
/rest/api/check-domain	POST	XML	Validate's and return's domain.
/rest/api/update-domain	POST	XML	Update the content of a domain.
/rest/api/delete-domain	POST	XML	Delete a domain
/rest/api/flag-domain	POST	XML	Flag a domain.
/rest/api/star-domain	POST	XML	Placing a star to a domain.
/rest/api/thumbs-up-domain	POST	XML	Placing a thumbs up to a domain.
/rest/api/thumbs-down-domain	POST	XML	Thumbs down to a selected domain.

Gráficos URL Extremos

URL	Operation	Type	Description
/rest/api/get-graphics	POST	XML	Retrieve all graphics.
/rest/api/get-graphic-users	POST	XML	Get all users of a selected graphic.
/rest/api/get-graphic-admins	POST	XML	Get all admins of a graphic.
/rest/api/update-graphic	POST	XML	Update the contents of a graphic.
/rest/api/update-graphic-icon	POST	XML	Update or change the current graphic icon.
/rest/api/update-graphic-media	POST	XML	Update media content of a graphic.
/rest/api/create-graphic	POST	XML	Create a new graphic.
/rest/api/delete-graphic	POST	XML	Delete a selected graphic.
/rest/api/check-graphic	POST	XML	Validate a graphic and return it back.
/rest/api/flag-graphic	POST	XML	Flag a graphic.
/rest/api/star-graphic	POST	XML	Placing a star to a graphic.
/rest/api/thumbs-up-graphic	POST	XML	Thumbs up a selected graphic.
/rest/api/thumbs-down-graphic	POST	XML	Thumbs down a selected graphic.

Analytics URL Extremos

URL	Operation	Type	Description
/rest/api/get-analytics	POST	XML	Retrieve all analytics.
/rest/api/get-analytic-users	POST	XML	Get all users of a selected analytic.
/rest/api/get-analytic-admins	POST	XML	Get all admins of an analytic.
/rest/api/test-analytic	POST	XML	Test a trained analytic model.
/rest/api/test-audio-analytic	POST	XML	Test an audio model analytic.
/rest/api/test-object-detection-analytic	POST	XML	Test an object detection image.
/rest/api/get-test-media-result	POST	XML	Retrieve test media results.
/rest/api/report-media-analytic	POST	XML	An analytic reprot.
/rest/api/train-analytic	POST	XML	Train a model analytic.
/rest/api/delete-analytic-media	POST	XML	Delete an analytic media.
/rest/api/delete-analytic-test-media	POST	XML	Delete analytic test media.
/rest/api/get-analytic-media	POST	XML	Retrieve all analytic media.
/rest/api/get-analytic-test-media	POST	XML	Retrieve an analytic test media.
/rest/api/create-analytic-label	POST	XML	Create a label to classify an object for a speicifc Analytic.
/rest/api/create-analytic-test-media-label	POST	XML	Create a label to classify an object for a speicifc Analytic.
/rest/api/delete-analytic-label	POST	XML	Delete a label of an analytic.
/rest/api/delete-analytic-test-media-label	POST	XML	Delete a test media label of an analytic.
/rest/api/check-training	POST	XML	Check current training of a model.
/rest/api/create-analytic	POST	XML	Create a new Analytic.
/rest/api/update-analytic	POST	XML	Update the content's of an analytic.
/rest/api/flag-analytic	POST	XML	Flag an Analytic.
/rest/api/thumbs-up-analytic	POST	XML	Thumbs up an Analytic.
/rest/api/thumbs-down-analytic	POST	XML	Thumbs down to an Analytic.
/rest/api/star-analytic	POST	XML	Placing a star to an analytic.
/rest/api/delete-analytic	POST	XML	Delete an analytic.
/rest/api/check-analytic	POST	XML	Validate an instance of an analytic and return it.
/rest/api/reset-data-analytic	POST	XML	Reset the data of an analytic object.
/rest/api/test-data-analytic	POST	XML	Test the data analytic.
/rest/api/train-data-analytic	POST	XML	Train the data analytic.

Chat API URL Extremos

Form Chat

URI: https://www.botlibre.com/rest/api/form-chat
Operation: GET
Type: Form
El formulario de chat API recibe un mensaje de chat y devuelve el chat bot respuesta como un documento XML.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
instance		attribute	The ID of the bot to chat with. The bot's name can also be used, but the ID is better as it is guaranteed to be unique.
user		attribute	The ID of the user who is sending the message. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private. The user/password are only required on the first message.
password		attribute	The password of the user who is sending the message. A token can also be used.
token		attribute	The token of the user who is sending the message. A token can be obtained through check-user, and is valid until reset.
conversation		attribute	The conversation ID for the current conversation. This must not be passed on the first message, but will be returned by the response, and should be used for all subsequent messages in the conversation.
message		element	The chat message to send to the bot. The message can be omitted if you wish the bot to start the conversation (if the bot has a greeting set). The message must be encoded in the URI.
emote		attribute	A emotion to tag the message with. This is one of LOVE, LIKE, DISLIKE, HATE, RAGE, ANGER, CALM, SERENE, ECSTATIC, HAPPY, SAD, CRYING, PANIC, AFRAID, CONFIDENT, COURAGEOUS, SURPRISE, BORED, LAUGHTER, SERIOUS.
correction		attribute	A boolean that defines the chat message is a correction to the bot's last answer.
offensive		attribute	A boolean that defines the bot's last answer as offensive. The message will be flagged for the bot's administrator to review.
disconnect		attribute	A boolean that defines the end of the conversation.
includeQuestion		attribute	A boolean that indicates the question should be included in the response.

Ejemplo

Test

Ejemplo De Resultado

XML Chat

URI: https://www.botlibre.com/rest/api/chat
Operation: POST
Type: XML
El chat de la API recibe un mensaje de chat y devuelve el chat bot respuesta como un documento XML.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
instance		attribute	The ID of the bot to chat with. The bot's name can also be used, but the ID is better as it is guaranteed to be unique.
user		attribute	The ID of the user who is sending the message. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private. The user/password are only required on the first message.
password		attribute	The password of the user who is sending the message. A token can also be used.
token		attribute	The token of the user who is sending the message. A token can be obtained through check-user, and is valid until reset.
conversation		attribute	The conversation ID for the current conversation. This must not be passed on the first message, but will be returned by the response, and should be used for all subsequent messages in the conversation.
message		element	The chat message to send to the bot. The message can be omitted if you wish the bot to start the conversation (if the bot has a greeting set). The message must be encoded in the URI.
emote		attribute	A emotion to tag the message with. This is one of LOVE, LIKE, DISLIKE, HATE, RAGE, ANGER, CALM, SERENE, ECSTATIC, HAPPY, SAD, CRYING, PANIC, AFRAID, CONFIDENT, COURAGEOUS, SURPRISE, BORED, LAUGHTER, SERIOUS.
correction		attribute	A boolean that defines the chat message is a correction to the bot's last answer.
offensive		attribute	A boolean that defines the bot's last answer as offensive. The message will be flagged for the bot's administrator to review.
disconnect		attribute	A boolean that defines the end of the conversation.
includeQuestion		attribute	A boolean that indicates the question should be included in the response.

Ejemplo

Test

Ejemplo De Resultado

JSON Chat

URI: https://www.botlibre.com/rest/json/chat
Operation: POST
Type: JSON

Parameters

Parameter	Required	Type	Description

Test

El usuario de la API URL Extremos

Form-Check-User

URI: https://www.botlibre.com/rest/api/form-check-user
Operation: GET
Type: Form
El formulario de verificación de usuario de la API valida usuario, y devuelve los datos del usuario.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Ejemplo

Test

Ejemplo De Resultado

Check-User

URI: https://www.botlibre.com/rest/api/check-user
Operation: POST
Type: XML
El check-usuario de la API valida usuario, y devuelve los datos del usuario.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Ejemplo

Test

Ejemplo De Resultado

Bot API URL Extremos

Get-Bots

URI: https://www.botlibre.com/rest/api/get-bots
Operation: POST
Type: XML
La API get-bots utilizada para recuperar todos los bots disponibles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user who is getting the users. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate		attribute	Filter all the private bot items.
type		attribute	Type of bot.
typeFilter		attribute	Filter type of bot.
userFilter		attribute	Filter by users.
tag		attribute	Filter by tag.
category		attribute	Filter by category.
filter		attribute	Filter by name or description keywords.
contentRating		attribute	Filter by content rating.
restrict		attribute	Filter restriction.
sort		attribute	Sort condition.
page		attribute	Result page.

Test

Get-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/get-bot-script-source
Operation: POST
Type: XML
La API get-bot-script-source utilizada para obtener el origen del script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the bot.

Test

Delete-Bot-Script

URI: https://www.botlibre.com/rest/api/delete-bot-script
Operation: POST
Type: XML
La API delete-bot-script utilizada para eliminar un script de un bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the bot.

Test

Import-Bot-Script

URI: https://www.botlibre.com/rest/api/import-bot-script
Operation: POST
Type: XML
La API import-bot-script utilizada para importar un script a un bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the bot.

Test

Import-Bot-Log

URI: https://www.botlibre.com/rest/api/import-bot-log
Operation: POST
Type: XML
La API import-bot-log utilizada para importar registros de un bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the bot.

Test

Save-Bot-Avatar

URI: https://www.botlibre.com/rest/api/save-bot-avatar
Operation: POST
Type: XML
La API save-bot-avatar utilizada para elegir un avatar y guardar para un bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation.
id		attribute	Bot's ID.
password		attribute	The password of the user who is creating the instance.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instanceAvatar		attribute	Instance avatar.

Test

Save-Bot-Script-Source

URI: https://www.botlibre.com/rest/api/save-bot-script-source
Operation: POST
Type: XML
La API save-bot-script-source utilizada para elegir un script y guardarlo para un bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Scripts's ID.
source			Script source code to update.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the bot.

Test

Create-Bot-Attachment

URI: https://www.botlibre.com/rest/api/create-bot-attachment
Operation: POST
Type: XML

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user perforing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the bot attachment.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the bot.
name		attribute	Attachment name.
type		attribute	Attachment type.
file		file	Bot attachment file.

Test

Up-Bot-Script

URI: https://www.botlibre.com/rest/api/up-bot-script
Operation: POST
Type: XML
La API up-bot-script utilizada para mover el script de bot hacia arriba.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the bot.

Test

Down-Bot-Script

URI: https://www.botlibre.com/rest/api/down-bot-script
Operation: POST
Type: XML
La API down-bot-script utilizada para mover hacia abajo el script de bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the bot.

Test

Get-Instances

URI: https://www.botlibre.com/rest/api/get-instances
Operation: POST
Type: XML
La API get-instances recuperará todas las instancias disponibles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate			Filter all the private instance items.
type			Type of instance.
typeFilter			Filter type of instance.
userFilter			Filter by user.
tag			Filter by tag.
category			Filter by category.
contentRating			Filter by content rating.
restrict			Filter restriction.
sort			Sort condition.
page		attribute	Result page.

Test

Get-Instance-Users

URI: https://www.botlibre.com/rest/api/get-instance-users
Operation: POST
Type: XML
La API get-instance-users recuperará todos los usuarios de esa instancia de bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
user		attribute	The ID of the user performing the operation.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Instance-Admins

URI: https://www.botlibre.com/rest/api/get-instance-admins
Operation: POST
Type: XML
La API get-instance-admins recuperará todos los administradores de esa instancia de bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
user		attribute	The ID of the user performing the operation.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-All-Instances

URI: https://www.botlibre.com/rest/api/get-all-instances
Operation: POST
Type: XML
La forma-obtener todas las instancias de la API de consultas de los detalles de todos los bot instancias.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate			Filter all the private instance items.
type			Type of instance.
typeFilter			Filter type of instance.
userFilter			Filter by user.
tag			Filter by tag.
category			Filter by category.
contentRating			Filter by content rating.
restrict			Filter restriction.
sort			Sort condition.
page		attribute	Result page.

Ejemplo

Test

Ejemplo De Resultado

Check-Instance

URI: https://www.botlibre.com/rest/api/check-instance
Operation: POST
Type: XML
El check-instancia de la API de valida que un bot ID o nombre existe, y devuelve el bot detalles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
name		attribute	The name of the bot to validate. The bot's ID can also be used.
user		attribute	The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Ejemplo

Test

Ejemplo De Resultado

Form-Check-Instance

URI: https://www.botlibre.com/rest/api/form-check-instance
Operation: GET
Type: Form
El formulario de verificación de instancia de la API de valida que un bot ID o nombre existe, y devuelve el bot detalles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
name		attribute	The name of the bot to validate. The bot's ID can also be used.
user		attribute	The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Ejemplo

Test

Ejemplo De Resultado

Form-Get-All-Instances

URI: https://www.botlibre.com/rest/api/form-get-all-instances
Operation: GET
Type: Form
La forma-obtener todas las instancias de la API de consultas de los detalles de todos los bot instancias.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required to query private bots.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
tag		attribute	The tag to filter the bots by.
sort		attribute	The sort option for the query. One of "name", "date", "dailyConnects", "weeklyConnects", "monthlyConnects".
filterPrivate		attribute	Set if only the user's private bots should be returned.

Ejemplo

Test

Ejemplo De Resultado

Update-Instance

URI: https://www.botlibre.com/rest/api/update-instance
Operation: POST
Type: XML
La API de instancia de actualización puede permitir que el usuario actualice todo el contenido de la instancia de bot seleccionada

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user. The user must be registered with Bot Libre.
id		attribute	Bot's ID.
password		attribute	The password of the user who is creating the instance.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
allowForking		attribute	Allow forking.
name		attribute	The instance name that used to identify the instance.
alias		attribute	Another name can be used for the new instance to be identified.
description			Brief description for the instance.
details			Details for the instance.
disclaimer			Disclaimer regarding the new instance.
license			License to release the instance and all its content under.
website			URL for the instance if it has it's own website.
subdomain			You can choose a subdomain to host your own website, or give a domain that you have registered and forward to this server's ip address.
categories			On what category would you place your instance. Must select at least one of the categories. (Misc, Fun, Education, Friends).
tags			Tags for your instance
isPrivate		attribute	Instance can be private, and accessed only by the user.
isHidden		attribute	Hidden instance will not be available to public.
accessMode		attribute	Instance will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Instance will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Instance can be viewed or rated for (Everyone, Teen, Mature).
creator		attribute	Instance creator.

Test

Update-Instance-Icon

URI: https://www.botlibre.com/rest/api/update-instance-icon
Operation: POST
Type: XML
La API update-instance-icon permite al usuario cambiar el icono de la instancia de bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
file		file	The icon image file

Test

Create-Instance

URI: https://www.botlibre.com/rest/api/create-instance
Operation: POST
Type: XML
La API create-instance para crear una nueva instancia de bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user. The user must be registered with Bot Libre.
template			Id or alias of bot to use as the template.
password		attribute	The password of the user who is creating the instance.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The instance name that used to identify the instance.
alias		attribute	Another name can be used for the new instance to be identified.
description			Brief description for the instance.
details			Details for the instance.
disclaimer			Disclaimer regarding the new instance.
license			License to release the instance and all its content under.
website			URL for the instance if it has it's own website.
categories			On what category would you place your instance. Must select at least one of the categories. (Misc, Fun, Education, Friends).
tags			Tags for your instance
isPrivate		attribute	Instance can be private, and accessed only by the user.
isHidden		attribute	Hidden instance will not be available to public.
accessMode		attribute	Instance will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Instance will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Instance can be viewed or rated for (Everyone, Teen, Mature).

Test

Delete-Instance

URI: https://www.botlibre.com/rest/api/delete-instance
Operation: POST
Type: XML
La API de instancia de eliminación para eliminar una instancia de bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Flag-Instance

URI: https://www.botlibre.com/rest/api/flag-instance
Operation: POST
Type: XML
La API flag-instance Marca una instancia de bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
user		attribute	The ID of the user who performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason		element	Flagged Reason.

Test

Star-Instance

URI: https://www.botlibre.com/rest/api/star-instance
Operation: POST
Type: XML
La API de instancia en estrella protagoniza una instancia de bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
stars		attribute	Stars.

Test

Train-Instance

URI: https://www.botlibre.com/rest/api/train-instance
Operation: POST
Type: XML
La API train-instance entrena una instancia de bot de chat.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the opertaion. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the bot.
operation		attribute	The training operation, one of AddGreeting, RemoveGreeting, AddDefaultResponse, RemoveDefaultResponse, AddResponse.
question		element	The training question text.
response		element	The training response text.

Test

Thumbs-Up-Instance

URI: https://www.botlibre.com/rest/api/thumbs-up-instance
Operation: POST
Type: XML
La API de instancia de pulgares hacia arriba un usuario puede colocar un pulgar hacia arriba a una instancia de bot de chat.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-instance
Operation: POST
Type: XML
La instancia de pulgares hacia abajo que un usuario puede colocar un pulgar hacia abajo en una instancia de bot de chat

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Puntos finales de URL de la API de chat en vivo

Get-Channel-Bot-Mode

URI: https://www.botlibre.com/rest/api/get-channel-bot-mode
Operation: POST
Type: XML
La API get-channel-bot-mode usó el modo get channel bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user who is getting the channel of the bot. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private. The user/password are only required on the first message.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Save Channel Bot Mode

URI: https://www.botlibre.com/rest/api/save-channel-bot-mode
Operation: POST
Type: XML
La API save-channel-bot-mode utilizada para guardar el modo bot de canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
instance		attribute	The ID of the channel.
user		attribute	The ID of the user who is saving the channel of the bot. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private. The user/password are only required on the first message.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
bot		attribute	The instance of the Bot.
mode		attribute	The mode of the Bot.

Test

Create channel attachment

URI: https://www.botlibre.com/rest/api/create-channel-attachment
Operation: POST
Type: XML
La API create-channel-attachment utilizada para crear un archivo adjunto para un canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user creating the channel attachment. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the channel attachment.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the channel.
name		attribute	Attachment name.
type		attribute	Attachment type.
file		file	Channel attachment file.

Test

Create Channel

URI: https://www.botlibre.com/rest/api/create-channel
Operation: POST
Type: XML
La API create-channel utilizada para crear un nuevo canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user creating the channel. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the channel.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
subdomain		attribute	Subdomain.
name		attribute	The channel name that used to identify the channel.
type		attribute	Channel type.
description		element	Brief description for the channel.
details		element	Details for the channel.
disclaimer		element	Disclaimer regarding the new channel.
license		element	License to release the channel and all its content under.
website		element	URL for the channel if it has it's own website.
categories		element	On what category would you place your channel. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags		element	Tags for your channel
isPrivate		attribute	Channel can be private, and accessed only by the user.
isHidden		attribute	Hidden channel will not be available to public.
accessMode		attribute	Channel will be accessed by based on the following options (Everyone, Users, Members, Admin).
videoAccessMode		attribute	Video access mode.
contentRating		attribute	Channel can be viewed or rated for (Everyone, Teen, Mature).
audioAccessMode		attribute	Audio access mode.
inviteAccessMode		attribute	Invite access mode.

Test

Create Channel

URI: https://www.botlibre.com/rest/api/update-channel
Operation: POST
Type: XML
La API de canal de actualización utilizada para actualizar un canal existente.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	The ID of the channel.
user		attribute	The ID of the user updating the channel. The user must be registered with Bot Libre.
password		attribute	The password of the user who is updating the channel.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Channel Domain.
name		attribute	The channel name that used to identify the channel.
type		attribute	Channel type.
description		element	Brief description for the channel.
details		element	Details for the channel.
disclaimer		element	Disclaimer regarding the new channel.
license		element	License to release the channel and all its content under.
website		element	URL for the channel if it has it's own website.
categories		element	On what category would you place your channel. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags		element	Tags for your channel
isPrivate		attribute	Channel can be private, and accessed only by the user.
isHidden		attribute	Hidden channel will not be available to public.
accessMode		attribute	Channel will be accessed by based on the following options (Everyone, Users, Members, Admin).
videoAccessMode		attribute	Video access mode.
contentRating		attribute	Channel can be viewed or rated for (Everyone, Teen, Mature).
audioAccessMode		attribute	Audio access mode.
inviteAccessMode		attribute	Invite access mode.

Test

Get bot channel

URI: https://www.botlibre.com/rest/api/get-bot-channel
Operation: POST
Type: XML
La API get-bot-channel utilizada para obtener el canal del bot.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot id for validation.
user		attribute	The ID of the user getting the channel of the bot.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
channelType		attribute	Channel type.

Test

Get user channel

URI: https://www.botlibre.com/rest/api/get-user-channel
Operation: POST
Type: XML
La API get-user-channel utilizada para obtener el canal de usuario.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user who's channel to get.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
channelType		attribute	Channel type.

Test

Get Channels

URI: https://www.botlibre.com/rest/api/get-channels
Operation: POST
Type: XML
La API get-channels utilizada para recuperar todos los canales disponibles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user who is retrieving all the channels. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate			Filter all the private channel items.
filterAdult			Filter all adult channel items.
type			Type of channel.
typeFilter			Filter type of channel.
userFilter			Filter by users.
tag		attribute	Filter by tag.
category		attribute	Filter by category.
filter		attribute	Filter by name or description keywords.
contentRating		attribute	Filter by content rating.
restrict		attribute	Filter restriction.
sort		attribute	Sort condition.
page		attribute	Result page.

Test

Get channel users

URI: https://www.botlibre.com/rest/api/get-channel-users
Operation: POST
Type: XML
La API get-channel-users utilizada para devolver todos los usuarios de un canal seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get Channel Admins

URI: https://www.botlibre.com/rest/api/get-channel-admins
Operation: POST
Type: XML
La API get-channel-admins utilizada para devolver todos los administradores de un canal seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user who is getting all the admins of the channel. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Update Channel Icon

URI: https://www.botlibre.com/rest/api/update-channel-icon
Operation: POST
Type: XML
La API update-channel-icon utilizada para actualizar el icono del canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user who is updating the icon of the channel. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
file		file	Icon

Test

Thumbs Up Channel

URI: https://www.botlibre.com/rest/api/thumbs-up-channel
Operation: POST
Type: XML
La API de canal de pulgar hacia arriba utilizada para permitir a los usuarios colocar un pulgar hacia arriba a un canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user who is performing a thumbs up to a channel. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Thumbs-Down-Instance

URI: https://www.botlibre.com/rest/api/thumbs-down-channel
Operation: POST
Type: XML
La API de canal de pulgar hacia arriba utilizada para permitir a los usuarios colocar un pulgar hacia abajo a un canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user who is performing a thumbs down to a channel. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Flag-Channel

URI: https://www.botlibre.com/rest/api/flag-channel
Operation: POST
Type: XML
La API de canal de bandera utilizada para marcar un canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user who is flagging a channel. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason		element	Flagged Reason.

Test

Star-Channel

URI: https://www.botlibre.com/rest/api/star-channel
Operation: POST
Type: XML
La API del canal estelar utilizada para destacar un canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user who is favourite a channel. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
stars		attribute	Stars.

Test

Delete-Channel

URI: https://www.botlibre.com/rest/api/delete-channel
Operation: POST
Type: XML
La API de canal de eliminación utilizada para eliminar un canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user who is deleting a channel. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Check-Channel

URI: https://www.botlibre.com/rest/api/check-channel
Operation: POST
Type: XML
La API de canal de comprobación utilizada para validar y devolver un canal.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Channel id for validation.
user		attribute	The ID of the user who is checking or validating a channel. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Foro de la API URL Extremos

Get-Forums

URI: https://www.botlibre.com/rest/api/get-forums
Operation: POST
Type: XML
La API get-forums utilizada para recuperar los foros disponibles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate		attribute	Filter all the private forums items.
type		attribute	Type of forums.
typeFilter		attribute	Filter type of forums.
userFilter		attribute	Filter by users.
tag		attribute	Filter by tag.
category		attribute	Filter by category.
filter		attribute	Filter by name or description keywords.
contentRating		attribute	Filter by content rating.
restrict		attribute	Filter restriction.
sort		attribute	Sort condition.
page		attribute	Result page.

Test

Get-Forum-Posts

URI: https://www.botlibre.com/rest/api/get-forum-posts
Operation: POST
Type: XML
La API get-forum-posts utilizada para recuperar las publicaciones disponibles de cada foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate		attribute	Filter all the private posts.
type		attribute	Type of forums.
typeFilter		attribute	Filter type of forum posts.
userFilter		attribute	Filter by users.
tag		attribute	Filter by tag.
category		attribute	Filter by category.
filter		attribute	Filter by name or description keywords.
contentRating		attribute	Filter by content rating.
restrict		attribute	Filter restriction.
sort		attribute	Sort condition.
page		attribute	Result page.

Test

Get-Forum-Users

URI: https://www.botlibre.com/rest/api/get-forum-users
Operation: POST
Type: XML
La API get-forum-users que se usa para recuperar usuarios de cada foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Forum-Admins

URI: https://www.botlibre.com/rest/api/get-forum-admins
Operation: POST
Type: XML
La API get-forum-admins utilizada para recuperar administradores de cada foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Save-Forum-Bot-Mode

URI: https://www.botlibre.com/rest/api/save-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter	Required	Type	Description

Test

Get-Forum-Bot-Mode

URI: https://www.botlibre.com/rest/api/get-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter	Required	Type	Description

Test

Create-Forum

URI: https://www.botlibre.com/rest/api/create-forum
Operation: POST
Type: XML
La API create-forum para crear un nuevo foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the forum.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The forum name that used to identify the forum.
alias		attribute	Another name can be used for the new forum to be identified.
description		element	Brief description for the forum.
details		element	Details for the forum.
disclaimer		element	Disclaimer regarding the new forum.
license		element	License to release the forum and all its content under.
website		element	URL for the forum if it has it's own website.
categories		element	On what category would you place your forum. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags		element	Tags for your forum
isPrivate		attribute	forum can be private, and accessed only by the user.
isHidden		attribute	Hidden forum will not be available to public.
accessMode		attribute	Forum will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Forum will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Forum can be viewed or rated for (Everyone, Teen, Mature).
replyAccessMode		attribute	Who can reply to a post in the forum.
postAccessMode		attribute	Who can post on the forum.

Test

Create-Forum-Attachment

URI: https://www.botlibre.com/rest/api/create-forum-attachment
Operation: POST
Type: XML
La API create-forum-attachment para crear un foro que contiene un archivo adjunto.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
instance			Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the forum.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
file			Forum file.
name			Attachment name.
type			Attachment type.

Test

Create-Forum-Post

URI: https://www.botlibre.com/rest/api/create-forum-post
Operation: POST
Type: XML
La API create-forum-post para crear una nueva publicación para un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the forum.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
topic			Post's topic
forum		attribute	The forum.
details			Type of a markup
tags			Tags
subscribe		boolean	Subscribe to this post to be notified once a reply is posted

Test

Update-Forum

URI: https://www.botlibre.com/rest/api/update-forum
Operation: POST
Type: XML
La API del foro de actualización utilizada para actualizar el contenido del foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
id		attribute	Forum's ID.
password		attribute	The password of the user who is updating the forum.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The forum name that used to identify the forum.
alias		attribute	Another name can be used for the new forum to be identified.
description			Brief description for the forum.
details			Details for the forum.
disclaimer			Disclaimer regarding the new forum.
license			License to release the forum and all its content under.
website			URL for the forum if it has it's own website.
categories			On what category would you place your forum. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags			Tags for your forum
isPrivate		attribute	forum can be private, and accessed only by the user.
isHidden		attribute	Hidden forum will not be available to public.
creator		attribute	Instance creator.
accessMode		attribute	Forum will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Forum will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Forum can be viewed or rated for (Everyone, Teen, Mature).
replyAccessMode		attribute	Who can reply to a post in the forum.
postAccessMode		attribute	Who can post on the forum.

Test

Update-Forum-Post

URI: https://www.botlibre.com/rest/api/update-forum-post
Operation: POST
Type: XML
La API update-forum-post actualiza el contenido de una publicación de un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the forum.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
replies			Post replies.
isFeatured		attribute	Featured forum.
topic			Post's topic
details			Post's text content
tags			Post's tags, csv

Test

Update-Forum-Icon

URI: https://www.botlibre.com/rest/api/update-forum-icon
Operation: POST
Type: XML
La API update-forum-icon se utiliza para cambiar el icono del fourm.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
file		file	Icon image file.

Test

Check-Forum

URI: https://www.botlibre.com/rest/api/check-forum
Operation: POST
Type: XML
La API del foro de comprobación valida y devuelve un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Check-Forum-Post

URI: https://www.botlibre.com/rest/api/check-forum-post
Operation: POST
Type: XML
La API check-forum-post comprueba la publicación del foro para validar y devuelve una publicación de un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Delete-Forum

URI: https://www.botlibre.com/rest/api/delete-forum
Operation: POST
Type: XML
La API delete-forum para eliminar un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Delete-Forum-Post

URI: https://www.botlibre.com/rest/api/delete-forum-post
Operation: POST
Type: XML
La API delete-forum-post es una publicación de un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Flag-Forum

URI: https://www.botlibre.com/rest/api/flag-forum
Operation: POST
Type: XML
La API flag-forum utilizada para marcar un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason		element	Flagged Reason.

Test

Flag-Forum-Post

URI: https://www.botlibre.com/rest/api/flag-forum-post
Operation: POST
Type: XML
El flag-forum-post API flag es una publicación de un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason		element	Flagged Reason.

Test

Thumbs-Up-Forum

URI: https://www.botlibre.com/rest/api/thumbs-up-forum
Operation: POST
Type: XML
La API de foro de pulgares hacia arriba se utiliza para colocar un pulgar hacia arriba en un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Thumbs-Down-Forum

URI: https://www.botlibre.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
La API de foro de pulgares hacia abajo se utiliza para colocar los pulgares hacia abajo en un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	TThe ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Subscribe-Forum

URI: https://www.botlibre.com/rest/api/subscribe-forum
Operation: POST
Type: XML
La API del foro de suscripción es permitir que un usuario se suscriba a un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Unsubscribe-Forum

URI: https://www.botlibre.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML
La API de unsubscribe-forum es permitir que el usuario se dé de baja de un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Star-Forum

URI: https://www.botlibre.com/rest/api/star-forum
Operation: POST
Type: XML
La API star-forum es permitir que un usuario coloque una estrella en un foro.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
stars		attribute	Stars.

Test

Secuencia de comandos de la API URL Extremos

Get-Scripts

URI: https://www.botlibre.com/rest/api/get-scripts
Operation: POST
Type: XML
La API get-scripts utilizada para recuperar scripts disponibles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate			Filter all the private script items.
filterAdult			Filter all adult script items.
type			Type of script.
typeFilter			Filter type of script.
userFilter			Filter by users.
tag		attribute	Filter by tag.
category		attribute	Filter by category.
filter		attribute	Filter by name or description keywords.
contentRating		attribute	Filter by content rating.
restrict		attribute	Filter restriction.
sort		attribute	Sort condition.
page		attribute	Result page.

Test

Get-Script-Users

URI: https://www.botlibre.com/rest/api/get-script-users
Operation: POST
Type: XML
La API get-script-users que se usa para recuperar usuarios de un script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Script-Admins

URI: https://www.botlibre.com/rest/api/get-script-admins
Operation: POST
Type: XML
La API get-script-admins es para recuperar todos los administradores de un script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Create-Script

URI: https://www.botlibre.com/rest/api/create-script
Operation: POST
Type: XML
La API create-script se utiliza para crear un nuevo script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the forum.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The forum name that used to identify the forum.
alias		attribute	Another name can be used for the new forum to be identified.
description			Brief description for the forum.
details			Details for the forum.
disclaimer			Disclaimer regarding the new forum.
license			License to release the forum and all its content under.
website			URL for the forum if it has it's own website.
categories			On what category would you place your forum. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags			Tags for your forum
isPrivate		attribute	forum can be private, and accessed only by the user.
isHidden		attribute	Hidden forum will not be available to public.
accessMode		attribute	Forum will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Forum will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Forum can be viewed or rated for (Everyone, Teen, Mature).

Test

Update-Script

URI: https://www.botlibre.com/rest/api/update-script
Operation: POST
Type: XML
La API update-script utilizada para actualizar el contenido del script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the script.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The script name that used to identify the script.
alias		attribute	Another name can be used for the new forum to be identified.
description			Brief description for the forum.
details			Details for the script.
disclaimer			Disclaimer regarding the new script.
license			License to release the script and all its content under.
website			URL for the forum if it has it's own website.
subdomain		attribute	You can choose a subdomain to host your script's own website, or give a domain that you have registered and forward to this server's ip address.
categories			On what category would you place your script. Must select at least one of the categories. (Bots, Bot Libre, Misc).
tags			Tags for your script
isPrivate		attribute	Scripts can be private, and accessed only by the user.
isHidden		attribute	Hidden forum will not be available to public.
accessMode		attribute	Script will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Script will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Script can be viewed or rated for (Everyone, Teen, Mature).
creator		attribute	Script creator.

Test

Update-Script-Icon

URI: https://www.botlibre.com/rest/api/update-script-icon
Operation: POST
Type: XML
La API update-script-icon utilizada para cambiar el icono del script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
file		file	Icon image file.

Test

Check-Script

URI: https://www.botlibre.com/rest/api/check-script
Operation: POST
Type: XML
La API check-forum valida y devuelve un script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Delete-Script

URI: https://www.botlibre.com/rest/api/delete-script
Operation: POST
Type: XML
La API delete-script para eliminar un script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Flag-Script

URI: https://www.botlibre.com/rest/api/flag-script
Operation: POST
Type: XML
La API de script de indicador utilizada para marcar un script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Thumbs-Up-Script

URI: https://www.botlibre.com/rest/api/thumbs-up-script
Operation: POST
Type: XML
La API del foro de pulgares hacia arriba utilizada para colocar un pulgar hacia arriba en un script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Thumbs-Down-Script

URI: https://www.botlibre.com/rest/api/thumbs-down-script
Operation: POST
Type: XML
La API del foro de pulgares hacia abajo utilizada para colocar los pulgares hacia abajo en un script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Star-Script

URI: https://www.botlibre.com/rest/api/star-script
Operation: POST
Type: XML
La API star-forum es permitir que un usuario coloque una estrella en un script.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Script's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Avatar API URL Extremos

Get-Avatars

URI: https://www.botlibre.com/rest/api/get-avatars
Operation: POST
Type: XML
La API get-avatars se utiliza para recuperar avatares disponibles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate			Filter all the private avatar items.
filterAdult			Filter all adult avatar items.
type			Type of avatar.
typeFilter			Filter type of avatar.
userFilter			Filter by users.
tag		attribute	Filter by tag.
category		attribute	Filter by category.
filter		attribute	Filter by name or description keywords.
contentRating		attribute	Filter by content rating.
restrict		attribute	Filter restriction.
sort		attribute	Sort condition.
page		attribute	Result page.

Test

Get-Avatar-Users

URI: https://www.botlibre.com/rest/api/get-avatar-users
Operation: POST
Type: XML
La API get-avatars-users que se usa para recuperar todos los usuarios relacionados con ese avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Avatar-Admins

URI: https://www.botlibre.com/rest/api/get-avatar-admins
Operation: POST
Type: XML
La API get-avatar-admins utilizada para recuperar todos los administradores de un avatar seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Avatar-Media

URI: https://www.botlibre.com/rest/api/get-avatar-media
Operation: POST
Type: XML
La API get-avatar-media utilizada para recuperar los medios de un avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Create-Avatar

URI: https://www.botlibre.com/rest/api/create-avatar
Operation: POST
Type: XML
La API create-avatar utilizada para crear un nuevo avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the avatar.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The avatar name that used to identify the avatar.
alias		attribute	Another name can be used for the new avatar to be identified.
description		element	Brief description for the avatar.
details		element	Details for the avatar.
disclaimer		element	Disclaimer regarding the new avatar.
license		element	License to release the avatar and all its content under.
website		element	URL for the avatar if it has it's own website.
categories		element	On what category would you place your avatar. Must select at least one of the categories. (People, 3D, Video, MP4).
tags		attribute	Tags for your avatar
isPrivate		attribute	Avatar can be private, and accessed only by the user.
isHidden		attribute	Hidden avatar will not be available to public.
accessMode		attribute	Avatar will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Avatar will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Avatar can be viewed or rated for (Everyone, Teen, Mature).

Test

Create-Avatar-Media

URI: https://www.botlibre.com/rest/api/create-avatar-media
Operation: POST
Type: XML
La API create-avatar-media utilizada para crear un medio para un avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the avatar.
name		attribute	Name of the media file.
type		attribute	Type of the avatar media file.
file		file	Media file.

Test

Save-Avatar-Media

URI: https://www.botlibre.com/rest/api/save-avatar-media
Operation: POST
Type: XML
La API save-avatar-media utilizada para guardar los medios actuales de cambios de un avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
mediaId		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
instance		attribute	The ID of the avatar.
name		attribute	Name of the media.
type		attribute	Type of the avatar media.
emotions		attribute	Emotions of the avatar.
actions		attribute	Actions of the avatar.
poses		attribute	Poses of the avatar.
hd		attribute	HD type of media.
talking		attribute	Talking state of the avatar.

Test

Save-Avatar-Background

URI: https://www.botlibre.com/rest/api/save-avatar-background
Operation: POST
Type: XML
La API save-avatar-background guarda la imagen de fondo de un avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
instance		attribute	The ID of the avatar.
name		attribute	Name of the media file.
type		attribute	Type of the avatar media file.
file		file	Background image file.

Test

Delete-Avatar

URI: https://www.botlibre.com/rest/api/delete-avatar
Operation: POST
Type: XML
La API delete-avatar utilizada para eliminar un avatar seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Delete-Avatar-Media

URI: https://www.botlibre.com/rest/api/delete-avatar-media
Operation: POST
Type: XML
La API delete-avatar-media utilizada para eliminar un medio de un avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
mediaId		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the avatar.

Test

Delete-Avatar-Background

URI: https://www.botlibre.com/rest/api/delete-avatar-background
Operation: POST
Type: XML
La API delete-avatar-background utilizada para eliminar una imagen de fondo de un avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Check-Avatar

URI: https://www.botlibre.com/rest/api/check-avatar
Operation: POST
Type: XML
La API check-avatar se utiliza para validar y devolver el avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Avatar-Message

URI: https://www.botlibre.com/rest/api/avatar-message
Operation: POST
Type: XML
La API de mensajes de avatar

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation.
password		attribute	Password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
message		element	Message.
avatar		attribute	Avatar id.
avatar		attribute	The avatar.
emote		attribute	The emote for the message.
action		attribute	The actoin for the message.
pose		attribute	The pose for the message.
speak		attribute	Speak.
voice		attribute	Voice used for the message.
voiceMode		attribute	Voice mode for the message.
format		attribute	Message format.
hd		attribute	HD.

Test

Star-Avatar

URI: https://www.botlibre.com/rest/api/star-avatar
Operation: POST
Type: XML
La API de avatar estrella utilizada para que el usuario marque un avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
stars		attribute	Stars.

Test

Flag-Avatar

URI: https://www.botlibre.com/rest/api/flag-avatar
Operation: POST
Type: XML
La API flag-avatar utilizada para marcar un avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason		element	Flagged Reason.

Test

Init-Avatar

URI: https://www.botlibre.com/rest/api/init-avatar
Operation: POST
Type: XML

Parameters

Parameter	Required	Type	Description

Test

Update-Avatar

URI: https://www.botlibre.com/rest/api/update-avatar
Operation: POST
Type: XML
La API de avatar de actualización utilizada para actualizar y cambiar el contenido de un avatar.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The avatar name that used to identify the avatar.
alias		attribute	Another name can be used for the new avatar to be identified.
description		element	Brief description for the avatar.
details		element	Details for the avatar.
disclaimer		element	Disclaimer regarding the new avatar.
license		element	License to release the avatar and all its content under.
website		element	URL for the avatar if it has it's own website.
categories		element	On what category would you place your avatar. Must select at least one of the categories. (People, 3D, Video, MP4).
tags		element	Tags for your avatar
isPrivate		attribute	Avatar can be private, and accessed only by the user.
isHidden		attribute	Hidden avatar will not be available to public.
accessMode		attribute	Avatar will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Avatar will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Avatar can be viewed or rated for (Everyone, Teen, Mature).
isFeatured		attribute	Featured instance.
creator		attribute	Instance creator.

Test

Update-Avatar-Icon

URI: https://www.botlibre.com/rest/api/update-avatar-icon
Operation: POST
Type: XML
La API update-avatar-icon utilizada para actualizar el icono del avatar

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
file		file	Icon image file.

Test

Thumbs-Up-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-up-avatar
Operation: POST
Type: XML
La API de avatar de pulgares hacia arriba se utiliza para colocar un pulgar hacia arriba en un avatar seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Thumbs-Down-Avatar

URI: https://www.botlibre.com/rest/api/thumbs-down-avatar
Operation: POST
Type: XML
La API de avatar de pulgares hacia abajo se usa para colocar un pulgar hacia abajo a un avatar seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Dominio de la URL Extremos

Get-Domains

URI: https://www.botlibre.com/rest/api/get-domains
Operation: POST
Type: XML
La API get-domains que se usa para recuperar todos los dominios disponibles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate			Filter all the private domain items.
filterAdult			Filter all adult domain items.
type			Type of domain.
typeFilter			Filter type of domain.
userFilter			Filter by users.
tag		attribute	Filter by tag.
category		attribute	Filter by category.
filter		attribute	Filter by name or description keywords.
contentRating		attribute	Filter by content rating.
restrict		attribute	Filter restriction.
sort		attribute	Sort condition.
page		attribute	Result page.

Test

Get-Domain-Users

URI: https://www.botlibre.com/rest/api/get-domain-users
Operation: POST
Type: XML
La API get-domain-users que se usa para recuperar todos los usuarios de un dominio.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Domain-Admins

URI: https://www.botlibre.com/rest/api/get-domain-admins
Operation: POST
Type: XML
La API get-domain-admins que se usa para recuperar todos los administradores de un dominio.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Domain

URI: https://www.botlibre.com/rest/api/get-domain
Operation: POST
Type: XML
La API get-domain recupera un dominio seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Domain-Icon

URI: https://www.botlibre.com/rest/api/get-domain-icon
Operation: POST
Type: XML
La API get-domain-icon que se usa para devolver un icono de un dominio.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Create-Domain

URI: https://www.botlibre.com/rest/api/create-domain
Operation: POST
Type: XML
La API create-domain create es un nuevo dominio.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the domain.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
name		attribute	The domain name that used to identify the domain.
alias		attribute	Another name can be used for the new domain to be identified.
description			Brief description for the domain.
details			Details for the domain.
disclaimer			Disclaimer regarding the new domain.
license			License to release the domain and all its content under.
website			URL for the domain if it has it's own website.
subdomain			You can choose a subdomain to host your forum's own website, or give a domain that you have registered and forward to this server's ip address.
categories			On what category would you place your domain. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags			Tags for your domain
isPrivate		attribute	Instance can be private, and accessed only by the user.
isHidden		attribute	Hidden domain will not be available to public.
accessMode		attribute	Domain will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Domain will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Domain can be viewed or rated for (Everyone, Teen, Mature).
creationMode		attribute	Who can create channels, forums, bots in this domain.

Test

Check-Domain

URI: https://www.botlibre.com/rest/api/check-domain
Operation: POST
Type: XML
La API de dominio de comprobación que se usa para validar y devolver un dominio.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Update-Domain

URI: https://www.botlibre.com/rest/api/update-domain
Operation: POST
Type: XML
La API de dominio de actualización actualiza el contenido del dominio.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the domain.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
name		attribute	The domain name that used to identify the domain.
alias		attribute	Another name can be used for the new domain to be identified.
description			Brief description for the domain.
details			Details for the domain.
disclaimer			Disclaimer regarding the new domain.
license			License to release the domain and all its content under.
website			URL for the domain if it has it's own website.
subdomain			You can choose a subdomain to host your forum's own website, or give a domain that you have registered and forward to this server's ip address.
categories			On what category would you place your domain. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags			Tags for your domain
isPrivate		attribute	Instance can be private, and accessed only by the user.
isHidden		attribute	Hidden domain will not be available to public.
accessMode		attribute	Domain will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Domain will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Domain can be viewed or rated for (Everyone, Teen, Mature).
creator		attribute	Instance creator.
creationMode			Who can create channels, forums, bots in this domain.

Test

Delete-Domain

URI: https://www.botlibre.com/rest/api/delete-domain
Operation: POST
Type: XML
La API delete-domain elimina un dominio seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Flag-Domain

URI: https://www.botlibre.com/rest/api/flag-domain
Operation: POST
Type: XML
La API de dominio de bandera utilizada para marcar un dominio.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason		element	Flagged Reason.

Test

Star-Domain

URI: https://www.botlibre.com/rest/api/star-domain
Operation: POST
Type: XML
La API de dominio de estrella utilizada para colocar una estrella en un dominio.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
stars		attribute	Stars.

Test

Thumbs-Up-Domain

URI: https://www.botlibre.com/rest/api/thumbs-up-domain
Operation: POST
Type: XML
La API de dominio de pulgares hacia arriba que se usa para aumentar un dominio.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Thumbs-Down-Domain

URI: https://www.botlibre.com/rest/api/thumbs-down-domain
Operation: POST
Type: XML
La API de dominio con los pulgares hacia abajo que se usa para bajar los pulgares a un dominio seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Gráficos URL Extremos

Get-Graphics

URI: https://www.botlibre.com/rest/api/get-graphics
Operation: POST
Type: XML
La API get-graphics recupera todos los gráficos disponibles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate			Filter all the private graphic items.
filterAdult			Filter all adult graphic items.
type			Type of graphic.
typeFilter			Filter type of graphic.
userFilter			Filter by users.
tag		attribute	Filter by tag.
category		attribute	Filter by category.
filter		attribute	Filter by name or description keywords.
contentRating		attribute	Filter by content rating.
restrict		attribute	Filter restriction.
sort		attribute	Sort condition.
page		attribute	Result page.

Test

Get-Graphic-Users

URI: https://www.botlibre.com/rest/api/get-graphic-users
Operation: POST
Type: XML
La API get-graphic-users devuelve todos los usuarios de un gráfico seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Graphic-Admins

URI: https://www.botlibre.com/rest/api/get-graphic-admins
Operation: POST
Type: XML
La API get-graphic-admins devuelve todos los administradores de un gráfico seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Update-Graphic

URI: https://www.botlibre.com/rest/api/update-graphic
Operation: POST
Type: XML
Api de gráfico de actualización utilizada para actualizar el contenido de un gráfico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id			Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is updating the graphic.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The graphic name that used to identify the graphic.
alias		attribute	Another name can be used for the new graphic to be identified.
description		element	Brief description for the graphic.
details		element	Details for the graphic.
disclaimer		element	Disclaimer regarding the new graphic.
license		element	License to release the graphic and all its content under.
website		element	URL for the graphic if it has it's own website.
categories		element	On what category would you place your graphic. Must select at least one of the categories. (Image, Audio, Data, Misc).
tags		element	Tag your Graphic
isPrivate		attribute	Graphic can be private, and accessed only by the user.
isHidden		attribute	Hidden graphic will not be available to public.
accessMode		attribute	Graphic will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Graphic will be able to copy by based on the following options (Everyone, Users, Members, Admin).
accessMode		attribute	Graphic can be viewed or rated for (Everyone, Teen, Mature).
contentRating		attribute	Graphic can be viewed or rated for (Everyone, Teen, Mature).
isFeatured		attribute	Featured instance.
creator		attribute	Instance creator.

Test

Update-Graphic-Icon

URI: https://www.botlibre.com/rest/api/update-graphic-icon
Operation: POST
Type: XML
La API update-graphic-icon utilizada para cambiar y actualizar el icono gráfico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
file		file	Icon image file.

Test

Update-Graphic-Media

URI: https://www.botlibre.com/rest/api/update-graphic-media
Operation: POST
Type: XML
La API update-graphic-media utilizada para actualizar el contenido multimedia del gráfico seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
id		attribute	Graphic's ID.
password		attribute	The password of the user who is creating the domain.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
fileName		attribute	File name of the graphic.
fileType		attribute	File type of the graphic.
file		file	Graphic file.

Test

Create-Graphic

URI: https://www.botlibre.com/rest/api/create-graphic
Operation: POST
Type: XML
La API create-graphic utilizada para crear un nuevo gráfico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the graphic.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The graphic name that used to identify the graphic.
alias		attribute	Another name can be used for the new graphic to be identified.
description		element	Brief description for the graphic.
details		element	Details for the graphic.
disclaimer		element	Disclaimer regarding the new graphic.
license		element	License to release the graphic and all its content under.
website		element	URL for the graphic if it has it's own website.
categories		element	On what category would you place your graphic. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags		element	Tags for your graphic
isPrivate		attribute	Instance can be private, and accessed only by the user.
isHidden		attribute	Hidden graphic will not be available to public.
accessMode		attribute	Graphic will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Graphic will be able to copy by based on the following options (Everyone, Users, Members, Admin).
contentRating		attribute	Graphic can be viewed or rated for (Everyone, Teen, Mature).

Test

Delete-Graphic

URI: https://www.botlibre.com/rest/api/delete-graphic
Operation: POST
Type: XML
La API de gráfico de eliminación utilizada para eliminar un gráfico seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Check-Graphic

URI: https://www.botlibre.com/rest/api/check-graphic
Operation: POST
Type: XML
La API de gráfico de comprobación utilizada para validar un gráfico y devolverlo.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Flag-Graphic

URI: https://www.botlibre.com/rest/api/flag-graphic
Operation: POST
Type: XML
La API de gráfico de bandera utilizada para marcar un gráfico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason		element	Flagged Reason.

Test

Star-Graphic

URI: https://www.botlibre.com/rest/api/star-graphic
Operation: POST
Type: XML
La API de gráficos en estrella se utiliza para colocar una estrella en un gráfico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
stars		attribute	Stars.

Test

Thumbs-Up-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-up-graphic
Operation: POST
Type: XML
La API de gráficos con pulgares hacia arriba se utiliza para colocar un pulgar hacia arriba en un gráfico seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Thumbs-Down-Graphic

URI: https://www.botlibre.com/rest/api/thumbs-down-graphic
Operation: POST
Type: XML
La API de gráficos con los pulgares hacia abajo se utiliza para colocar un pulgar hacia abajo en un gráfico seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Analytics URL Extremos

Get-Analytics

URI: https://www.botlibre.com/rest/api/get-analytics
Operation: POST
Type: XML
La API get-analytics utilizada para recuperar todos los análisis disponibles.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
filterPrivate		attribute	Filter all the private analytic items.
filterAdult		attribute	Filter all adult analytic items.
type		attribute	Type of analytics.
typeFilter		attribute	Filter type of analytic.
userFilter		attribute	Filter by users.
tag		attribute	Filter by tag.
category		attribute	Filter by category.
filter		attribute	Filter by name or description keywords.
contentRating		attribute	Filter by content rating.
restrict		attribute	Filter restriction.
sort		attribute	Sort condition.
page		attribute	Result page.

Test

Get-Analytic-Users

URI: https://www.botlibre.com/rest/api/get-analytic-users
Operation: POST
Type: XML
La API get-analytic-users utilizada para recuperar todos los usuarios de un análisis.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Analytic-Admins

URI: https://www.botlibre.com/rest/api/get-analytic-admins
Operation: POST
Type: XML
La API get-analytic-admins se utiliza para recuperar todos los administradores de un analítico seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Test-Analytic

URI: https://www.botlibre.com/rest/api/test-analytic
Operation: POST
Type: XML
La API analítica de prueba utilizada para probar un modelo analítico entrenado con instrucciones específicas.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the bot is private.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
file		file	The image as input to be recognized.

Test

Test-Audio-Analytic

URI: https://www.botlibre.com/rest/api/test-audio-analytic
Operation: POST
Type: XML
La API de prueba-audio-analítica utilizada para probar un modelo de audio analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
file		file	Audio file needed to audio recognize.

Test

Test-Object-Detection-Analytic

URI: https://www.botlibre.com/rest/api/test-object-detection-analytic
Operation: POST
Type: XML
La API test-object-detection-analytic utilizada para probar un modelo analítico de detección de objetos con instrucciones específicas.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	The ID of the Analytic.
file		file	Image to test for the object detection analytic.

Test

Get-Test-Media-Result

URI: https://www.botlibre.com/rest/api/get-test-media-result
Operation: POST
Type: XML
La API get-test-media-result recupera los resultados de los medios de prueba.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Report-Media-Analytic

URI: https://www.botlibre.com/rest/api/report-media-analytic
Operation: POST
Type: XML
La API de análisis de medios de informe utilizada para obtener una reprotección analítica.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
processingTestMediaStatus		attribute	Analytic test media status.

Test

Train-Analytic

URI: https://www.botlibre.com/rest/api/train-analytic
Operation: POST
Type: XML
La API de análisis de trenes utilizada para entrenar un modelo analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
trainingStatus		attribute	Analytic training status.
cycles		attribute	Analytic training cycles.

Test

Delete-Analytic-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-media
Operation: POST
Type: XML
La API delete-analytic-media utilizada para eliminar un medio analítico seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
mediaId		attribute	Analytic's media ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
label		attribute	Analytic label.

Test

Delete-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media
Operation: POST
Type: XML
La API delete-analytic-test-media utilizada para eliminar un medio de prueba de un analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
mediaId		attribute	Analytic's media ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
label		attribute	Analytic label.

Test

Get-Analytic-Media

URI: https://www.botlibre.com/rest/api/get-analytic-media
Operation: POST
Type: XML
La API get-analytic-media utilizada para recuperar todos los medios analíticos.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Get-Analytic-Test-Media

URI: https://www.botlibre.com/rest/api/get-analytic-test-media
Operation: POST
Type: XML
La API get-analytic-test-media recupera un medio de prueba de un analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Create-Analytic-Label

URI: https://www.botlibre.com/rest/api/create-analytic-label
Operation: POST
Type: XML
Cree una etiqueta o etiquetas para un analítico. Cada etiqueta es un clasificador. Cada etiqueta es como un paquete que contendrá un conjunto de imágenes. Esto es necesario antes de comenzar la fase de entrenamiento para el reconocimiento de imágenes. Cada analítico debe tener al menos dos etiquetas.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation.
password		attribute	Password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	Analytic's ID.
label		attribute	Analytic label.

Test

Create-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/create-analytic-test-media-label
Operation: POST
Type: XML
Cree una etiqueta o etiquetas para un analítico. Cada etiqueta es un clasificador. Cada etiqueta es como un paquete que contendrá un conjunto de imágenes. Esto es necesario antes de comenzar la fase de entrenamiento para el reconocimiento de imágenes. Cada analítico debe tener al menos dos etiquetas.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation.
password		attribute	Password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
instance		attribute	Analytic's ID.
label		attribute	Analytic label.

Test

Delete-Analytic-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-label
Operation: POST
Type: XML
La API delete-analytic-label utilizada para eliminar una etiqueta seleccionada de un objeto analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation.
password		attribute	Password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	Analytic's ID.
label		attribute	Analytic label.

Test

Delete-Analytic-Test-Media-Label

URI: https://www.botlibre.com/rest/api/delete-analytic-test-media-label
Operation: POST
Type: XML
La API delete-analytic-test-media-label que se utiliza para eliminar una etiqueta de medio de prueba de un analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation.
password		attribute	Password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	Analytic's ID.
label		attribute	Analytic label.

Test

Check-Training

URI: https://www.botlibre.com/rest/api/check-training
Operation: POST
Type: XML
La API de comprobación-entrenamiento utilizada para recuperar cierta información del entrenamiento actual de un modelo.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
id		attribute	Analytic's ID.
password		attribute	The password of the user who is creating the analytic.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Create-Analytic

URI: https://www.botlibre.com/rest/api/create-analytic
Operation: POST
Type: XML
La API create-analytic crea un nuevo Analytic.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the analytic.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The analytic name that used to identify the analytic.
alias		attribute	Another name can be used for the new analytic to be identified.
description		element	Brief description for the Analytic.
details		element	Details for the Analytic.
disclaimer		element	Disclaimer regarding the new Analytic.
license		element	License to release the Analytic and all its content under.
website		element	URL for the Analytic if it has it's own website.
categories		element	On what category would you place your Analytic. Must select at least one of the categories. (Image, Audio, Data, Misc).
tags		element	Tag your Analytic
isPrivate		attribute	Analytic can be private, and accessed only by the user.
isHidden		attribute	Hidden analytic will not be available to public.
accessMode		attribute	Analytic will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Analytic will be able to copy by based on the following options (Everyone, Users, Members, Admin).
accessMode		attribute	Analytic can be viewed or rated for (Everyone, Teen, Mature).
contentRating		attribute	Analytic can be viewed or rated for (Everyone, Teen, Mature).

Test

Update-Analytic

URI: https://www.botlibre.com/rest/api/update-analytic
Operation: POST
Type: XML
La API de análisis de actualización actualiza o cambia los detalles de un análisis seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
id		attribute	Analytic's ID.
password		attribute	The password of the user who is creating the analytic.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
domain		attribute	Domain.
name		attribute	The analytic name that used to identify the analytic.
alias		attribute	Another name can be used for the new analytic to be identified.
description		element	Brief description for the Analytic.
details		element	Details for the Analytic.
disclaimer		element	Disclaimer regarding the new Analytic.
license		element	License to release the Analytic and all its content under.
website		element	URL for the Analytic if it has it's own website.
categories		element	On what category would you place your Analytic. Must select at least one of the categories. (Image, Audio, Data, Misc).
tags		element	Tag your Analytic
isPrivate		attribute	Analytic can be private, and accessed only by the user.
isHidden		attribute	Hidden analytic will not be available to public.
accessMode		attribute	Analytic will be accessed by based on the following options (Everyone, Users, Members, Admin).
forkAccessMode		attribute	Analytic will be able to copy by based on the following options (Everyone, Users, Members, Admin).
accessMode		attribute	Analytic can be viewed or rated for (Everyone, Teen, Mature).
contentRating		attribute	Avatar can be viewed or rated for (Everyone, Teen, Mature).
isFeatured		attribute	Featured instance.
creator		attribute	Instance creator.

Test

Flag-Analytic

URI: https://www.botlibre.com/rest/api/flag-analytic
Operation: POST
Type: XML
La API de análisis de indicadores utilizada para colocar un indicador en un analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
flaggedReason		element	Flagged Reason.

Test

Thumbs-Up-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-up-analytic
Operation: POST
Type: XML
La API analítica de pulgares hacia arriba utilizada para pulgares hacia arriba de un analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Thumbs-Down-Analytic

URI: https://www.botlibre.com/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
La API analítica de pulgares hacia abajo utilizada para bajar el pulgar a un analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Star-Analytic

URI: https://www.botlibre.com/rest/api/star-analytic
Operation: POST
Type: XML
La API de análisis de estrellas se utiliza para estrellar un objeto analítico.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
stars		attribute	Stars.

Test

Delete-Analytic

URI: https://www.botlibre.com/rest/api/delete-analytic
Operation: POST
Type: XML
La API de análisis de eliminación utilizada para eliminar un análisis seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic's ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre.
password		attribute	The password of the user
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Check-Analytic

URI: https://www.botlibre.com/rest/api/check-analytic
Operation: POST
Type: XML
La API de análisis de comprobación utilizada para validar una instancia de un análisis y devolverla.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the analytic is private.
id		attribute	Analytic's ID.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Test

Reset-Data-Analytic

URI: https://www.botlibre.com/rest/api/reset-data-analytic
Operation: POST
Type: XML
La API de análisis de datos de reposo utilizada para descansar los datos de un analítico seleccionado.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user performing the operation. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the analytic is private.
id		attribute	Analytic's ID.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.

Ejemplo

Test

Test-Data-Analytic

URI: https://www.botlibre.com/rest/api/test-data-analytic
Operation: POST
Type: XML
Prueba el análisis de datos con un conjunto de entradas.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user perfoming the operation. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the analytic is private.
id		attribute	Analytic's ID.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
input		element	A comma-seperated list of floats to be trained as input.

Ejemplo

Test

Ejemplo De Resultado

Train-Data-Analytic

URI: https://www.botlibre.com/rest/api/train-data-analytic
Operation: POST
Type: XML
Tren el análisis de datos con varios conjuntos de entradas y salidas.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user. The user must be registered with Bot Libre. If not passed the user will be anonymous. The user is required if the analytic is private.
password		attribute	The password of the user. A token can also be used.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
instance		attribute	Analytic's ID.
data		element	Use the data tags to group the inputs with the corresponding outputs.
input		element	A comma-seperated list of floats to be trained as input.
output		element	A comma-seperated list of floats to be trained as output.

Ejemplo

Test

Puede llamar a cualquiera de las API anteriores mediante JSON en lugar de XML mediante el extremo /rest/json En lugar de /rest/api.

Ver También

• El Bot Libre de chat bot web API
• Web de la API de la Consola