Веб-API

В дополнение к возможности для размещения своего чата ботов на свой сайт, и открыть их с любого устройства Android или iOS, Вы также можете получить доступ к чат-ботами через Сэп Libre веб-API. Веб-API дает вам преимущество иметь полный контроль над клиентским интерфейсом вашего бота.

Вы можете использовать веб-API для доступа к бот с вашего собственного сайта с помощью JavaScript, PHP или любой другой язык. Вы можете также использовать веб-API для создания собственных мобильных приложений для доступа к сэп, таких как приложения для Android или iOS.

Веб-API-это набор http-запрос Get/пост Ури, которые позволяют отправлять и получать сообщения данных. Когда вы просматриваете веб-сайт, Ваш браузер делает серию http-запрос Get/Post-запросы к URI, которые возвращают HTML-содержимого. В веб-службе URI, которые возвращают XML-или json-данные, а не HTML-содержимого.

Бот Либре веб-API предоставляет три API-интерфейс rest в одном. Первый представляет собой набор http-запрос Get URI, которые принимают данные формы, и возвращать данные в формате XML. Второй набор API возьмем данные http-запроса Post XML и возвращает данные в формате XML. Третий набор API возьмем данные http-запроса Post json и возвращать json.

Большинство приложений будет использовать XML-сообщение API, но некоторые приложения могут использовать форма получения API из-за своей простоты. API-Интерфейсы идентичны другим, чем их механизм.

Test

Беседы API URL-адреса конечных точек

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.

API пользовательского URL-адреса конечных точек

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.

Бот по API URL-адреса конечных точек

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

Конечные точки URL-адреса API онлайн-чата

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.

Форум по API URL-адреса конечных точек

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.

API скрипта URL-адреса конечных точек

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.

Аватар по API URL-адреса конечных точек

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.

Домен URL-адреса конечных точек

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.

Графика URL-адреса конечных точек

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.

Аналитика конечных точек URL

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.

Беседы API URL-адреса конечных точек

Form Chat

URI: https://www.botlibre.biz/rest/api/form-chat
Operation: GET
Type: Form
Форме-чат API получает сообщение и возвращает ответ в чат бота как 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.

Пример

Test

Пример Результата

XML Chat

URI: https://www.botlibre.biz/rest/api/chat
Operation: POST
Type: XML
Чат API получает сообщение и возвращает ответ в чат бота как 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.

Пример

Test

Пример Результата

JSON Chat

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

Parameters

Parameter	Required	Type	Description

Test

API пользовательского URL-адреса конечных точек

Form-Check-User

URI: https://www.botlibre.biz/rest/api/form-check-user
Operation: GET
Type: Form
API-пользователь проверки формы проверяет пользователя и возвращает данные пользователя.

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.

Пример

Test

Пример Результата

Check-User

URI: https://www.botlibre.biz/rest/api/check-user
Operation: POST
Type: XML
API-интерфейс чек-пользователя проверяет пользователя и возвращает данные пользователя.

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.

Пример

Test

Пример Результата

Бот по API URL-адреса конечных точек

Get-Bots

URI: https://www.botlibre.biz/rest/api/get-bots
Operation: POST
Type: XML
API get-bots, используемый для извлечения всех доступных ботов.

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.biz/rest/api/get-bot-script-source
Operation: POST
Type: XML
API get-bot-script-source, используемый для получения исходного кода скрипта.

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.biz/rest/api/delete-bot-script
Operation: POST
Type: XML
API delete-bot-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.
instance		attribute	The ID of the bot.

Test

Import-Bot-Script

URI: https://www.botlibre.biz/rest/api/import-bot-script
Operation: POST
Type: XML
API import-bot-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

Import-Bot-Log

URI: https://www.botlibre.biz/rest/api/import-bot-log
Operation: POST
Type: XML
API import-bot-log, используемый для импорта журналов бота.

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.biz/rest/api/save-bot-avatar
Operation: POST
Type: XML
API save-bot-avatar используется для выбора аватара и сохранения для бота.

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.biz/rest/api/save-bot-script-source
Operation: POST
Type: XML
API save-bot-script-source используется для выбора скрипта и сохранения для бота.

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.biz/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.biz/rest/api/up-bot-script
Operation: POST
Type: XML
API up-bot-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

Down-Bot-Script

URI: https://www.botlibre.biz/rest/api/down-bot-script
Operation: POST
Type: XML
API down-bot-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

Get-Instances

URI: https://www.botlibre.biz/rest/api/get-instances
Operation: POST
Type: XML
API get-instances извлекет все доступные экземпляры.

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.biz/rest/api/get-instance-users
Operation: POST
Type: XML
API get-instance-users извлечет всех пользователей этого экземпляра бота.

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.biz/rest/api/get-instance-admins
Operation: POST
Type: XML
API get-instance-admins извлечет всех администраторов этого экземпляра бота.

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.biz/rest/api/get-all-instances
Operation: POST
Type: XML
API-API с формой get-all-instances запрашивает сведения для всех экземпляров бота.

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

Пример Результата

Check-Instance

URI: https://www.botlibre.biz/rest/api/check-instance
Operation: POST
Type: XML
API проверки подтверждает наличие идентификатора или имени бота и возвращает данные бота.

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.

Пример

Test

Пример Результата

Form-Check-Instance

URI: https://www.botlibre.biz/rest/api/form-check-instance
Operation: GET
Type: Form
API с проверкой формы подтверждает наличие идентификатора или имени бота и возвращает данные бота.

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.

Пример

Test

Пример Результата

Form-Get-All-Instances

URI: https://www.botlibre.biz/rest/api/form-get-all-instances
Operation: GET
Type: Form
API-API с формой get-all-instances запрашивает сведения для всех экземпляров бота.

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.

Пример

Test

Пример Результата

Update-Instance

URI: https://www.botlibre.biz/rest/api/update-instance
Operation: POST
Type: XML
API экземпляра обновления может позволить пользователю обновлять все содержимое выбранного экземпляра бота

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.biz/rest/api/update-instance-icon
Operation: POST
Type: XML
API update-instance-icon позволяет пользователю изменять значок экземпляра бота.

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.biz/rest/api/create-instance
Operation: POST
Type: XML
API создания экземпляра для создания нового экземпляра бота.

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.biz/rest/api/delete-instance
Operation: POST
Type: XML
API удаления экземпляра для удаления экземпляра бота.

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.biz/rest/api/flag-instance
Operation: POST
Type: XML
API экземпляра флага Пометить экземпляр бота.

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.biz/rest/api/star-instance
Operation: POST
Type: XML
API звездного экземпляра помечает экземпляр бота.

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.biz/rest/api/train-instance
Operation: POST
Type: XML
API обучающего экземпляра обучает экземпляр чат-бота.

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.biz/rest/api/thumbs-up-instance
Operation: POST
Type: XML
API экземпляра thumbs-up,который пользователь может поместить большой палец вверх к экземпляру чат-бота.

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.biz/rest/api/thumbs-down-instance
Operation: POST
Type: XML
Экземпляр большого пальца вниз, который пользователь может поместить большой палец вниз к экземпляру чат-бота

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

Конечные точки URL-адреса API онлайн-чата

Get-Channel-Bot-Mode

URI: https://www.botlibre.biz/rest/api/get-channel-bot-mode
Operation: POST
Type: XML
API get-channel-bot-mode использовал режим 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.biz/rest/api/save-channel-bot-mode
Operation: POST
Type: XML
API режима save-channel-bot-mode, используемый для сохранения режима бота канала.

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.biz/rest/api/create-channel-attachment
Operation: POST
Type: XML
Используемый API create-channel-attachment создает вложение для канала.

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.biz/rest/api/create-channel
Operation: POST
Type: XML
API create-channel, используемый для создания нового канала.

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.biz/rest/api/update-channel
Operation: POST
Type: XML
API канала обновления, используемый для обновления существующего канала.

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.biz/rest/api/get-bot-channel
Operation: POST
Type: XML
API get-bot-channel, используемый для получения канала бота.

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.biz/rest/api/get-user-channel
Operation: POST
Type: XML
API get-user-channel, используемый для получения пользовательского канала.

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.biz/rest/api/get-channels
Operation: POST
Type: XML
API get-channels, используемый для получения всех доступных каналов.

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.biz/rest/api/get-channel-users
Operation: POST
Type: XML
API get-channel-users, используемый для возврата всех пользователей выбранного канала.

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.biz/rest/api/get-channel-admins
Operation: POST
Type: XML
API get-channel-admins, используемый для возврата всех администраторов выбранного канала.

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.biz/rest/api/update-channel-icon
Operation: POST
Type: XML
API update-channel-icon, используемый для обновления значка канала.

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.biz/rest/api/thumbs-up-channel
Operation: POST
Type: XML
API канала с большим пальцем вверх используется для того, чтобы пользователи могли ставить большой палец вверх на канал.

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.biz/rest/api/thumbs-down-channel
Operation: POST
Type: XML
API канала с большим пальцем вверх используется для того, чтобы пользователи могли ставить большой палец вниз на канал.

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.biz/rest/api/flag-channel
Operation: POST
Type: XML
API flag-channel, используемый для пометки канала.

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.biz/rest/api/star-channel
Operation: POST
Type: XML
API звездообразного канала, используемый для пометки канала.

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.biz/rest/api/delete-channel
Operation: POST
Type: XML
API канала удаления, используемый для удаления канала.

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.biz/rest/api/check-channel
Operation: POST
Type: XML
API check-channel, используемый для проверки и возврата канала.

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

Форум по API URL-адреса конечных точек

Get-Forums

URI: https://www.botlibre.biz/rest/api/get-forums
Operation: POST
Type: XML
API get-forums, используемый для получения доступных форумов.

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.biz/rest/api/get-forum-posts
Operation: POST
Type: XML
API get-forum-posts, используемый для получения доступных сообщений каждого форума.

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.biz/rest/api/get-forum-users
Operation: POST
Type: XML
API get-forum-users, используемый для извлечения пользователей каждого форума.

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.biz/rest/api/get-forum-admins
Operation: POST
Type: XML
API get-forum-admins, используемый для извлечения администраторов каждого форума.

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.biz/rest/api/save-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter	Required	Type	Description

Test

Get-Forum-Bot-Mode

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

Parameters

Parameter	Required	Type	Description

Test

Create-Forum

URI: https://www.botlibre.biz/rest/api/create-forum
Operation: POST
Type: XML
API создания форума для создания нового форума.

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.biz/rest/api/create-forum-attachment
Operation: POST
Type: XML
API create-forum-attachment для создания форума, содержащего вложение.

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.biz/rest/api/create-forum-post
Operation: POST
Type: XML
API create-forum-post для создания нового сообщения для форума.

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.biz/rest/api/update-forum
Operation: POST
Type: XML
API update-forum, используемый для обновления содержимого форума.

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.biz/rest/api/update-forum-post
Operation: POST
Type: XML
API update-forum-post обновляет содержимое сообщения форума.

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.biz/rest/api/update-forum-icon
Operation: POST
Type: XML
API update-forum-icon используется для изменения значка 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.biz/rest/api/check-forum
Operation: POST
Type: XML
API контрольного форума проверяет и возвращает форум.

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.biz/rest/api/check-forum-post
Operation: POST
Type: XML
API check-forum-post проверяет сообщение форума для проверки и возвращает сообщение форума.

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.biz/rest/api/delete-forum
Operation: POST
Type: XML
API удаления форума для удаления форума.

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.biz/rest/api/delete-forum-post
Operation: POST
Type: XML
API удаления-форума-записи удаления — это сообщение форума.

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.biz/rest/api/flag-forum
Operation: POST
Type: XML
API флаг-форум, используемый для пометки форума.

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.biz/rest/api/flag-forum-post
Operation: POST
Type: XML
Флаг API -форум-пост — это сообщение форума.

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.biz/rest/api/thumbs-up-forum
Operation: POST
Type: XML
API форума thumbs-up-forum используется для размещения большого пальца вверх к форуму.

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.biz/rest/api/thumbs-down-forum
Operation: POST
Type: XML
API форума с большими пальцами вниз используется для размещения больших пальцев вниз к форуму.

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.biz/rest/api/subscribe-forum
Operation: POST
Type: XML
API подписки на форум позволяет пользователю подписаться на форум.

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.biz/rest/api/unsubscribe-forum
Operation: POST
Type: XML
API форума отписок позволяет пользователю отказаться от подписки на форум.

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.biz/rest/api/star-forum
Operation: POST
Type: XML
API звездного форума позволяет пользователю поставить звездочку на форуме.

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

API скрипта URL-адреса конечных точек

Get-Scripts

URI: https://www.botlibre.biz/rest/api/get-scripts
Operation: POST
Type: XML
API get-scripts, используемый для получения доступных скриптов.

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.biz/rest/api/get-script-users
Operation: POST
Type: XML
API get-script-users, используемый для получения пользователей скрипта.

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.biz/rest/api/get-script-admins
Operation: POST
Type: XML
API get-script-admins предназначен для получения всех администраторов скрипта.

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.biz/rest/api/create-script
Operation: POST
Type: XML
API create-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.biz/rest/api/update-script
Operation: POST
Type: XML
API скрипта обновления, используемый для обновления содержимого скрипта.

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.biz/rest/api/update-script-icon
Operation: POST
Type: XML
API update-script-icon, используемый для изменения значка скрипта.

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.biz/rest/api/check-script
Operation: POST
Type: XML
API check-forum проверяет и возвращает сценарий.

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.biz/rest/api/delete-script
Operation: POST
Type: XML
API скрипта удаления для удаления скрипта.

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.biz/rest/api/flag-script
Operation: POST
Type: XML
API flag-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.biz/rest/api/thumbs-up-script
Operation: POST
Type: XML
API форума с большим пальцем вверх используется для размещения большого пальца вверх к сценарию.

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.biz/rest/api/thumbs-down-script
Operation: POST
Type: XML
API форума с большим пальцем вниз используется для размещения большого пальца вниз для скрипта.

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.biz/rest/api/star-script
Operation: POST
Type: XML
API star-forum позволяет пользователю ставить звездочку в скрипте.

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

Аватар по API URL-адреса конечных точек

Get-Avatars

URI: https://www.botlibre.biz/rest/api/get-avatars
Operation: POST
Type: XML
API get-avatars используется для получения доступных аватаров.

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.biz/rest/api/get-avatar-users
Operation: POST
Type: XML
API get-avatars-users, используемый для извлечения всех пользователей, связанных с этим аватаром.

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.biz/rest/api/get-avatar-admins
Operation: POST
Type: XML
API get-avatar-admins, используемый для извлечения всех администраторов выбранного аватара.

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.biz/rest/api/get-avatar-media
Operation: POST
Type: XML
API get-avatar-media, используемый для извлечения мультимедиа аватара.

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.biz/rest/api/create-avatar
Operation: POST
Type: XML
API создания аватара, используемый для создания нового аватара.

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.biz/rest/api/create-avatar-media
Operation: POST
Type: XML
API create-avatar-media, используемый для создания мультимедиа для аватара.

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.biz/rest/api/save-avatar-media
Operation: POST
Type: XML
API save-avatar-media, используемый для сохранения изменений текущего мультимедиа аватара.

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.biz/rest/api/save-avatar-background
Operation: POST
Type: XML
API сохранения-аватара-фона сохраняет фоновое изображение аватара.

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.biz/rest/api/delete-avatar
Operation: POST
Type: XML
API удаления аватара, используемый для удаления выбранного аватара.

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.biz/rest/api/delete-avatar-media
Operation: POST
Type: XML
API delete-avatar-media, используемый для удаления мультимедиа аватара.

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.biz/rest/api/delete-avatar-background
Operation: POST
Type: XML
API delete-avatar-background, используемый для удаления фонового изображения аватара.

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.biz/rest/api/check-avatar
Operation: POST
Type: XML
API check-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.biz/rest/api/avatar-message
Operation: POST
Type: XML
API аватар-сообщения

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.biz/rest/api/star-avatar
Operation: POST
Type: XML
API звездного аватара, используемый для того, чтобы пользователь мог отметить аватар.

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.biz/rest/api/flag-avatar
Operation: POST
Type: XML
API флаг-аватар, используемый для пометки аватара.

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.biz/rest/api/init-avatar
Operation: POST
Type: XML

Parameters

Parameter	Required	Type	Description

Test

Update-Avatar

URI: https://www.botlibre.biz/rest/api/update-avatar
Operation: POST
Type: XML
API update-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.biz/rest/api/update-avatar-icon
Operation: POST
Type: XML
API update-avatar-icon, используемый для обновления значка аватара

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.biz/rest/api/thumbs-up-avatar
Operation: POST
Type: XML
API «большой палец вверх-аватар», используемый для размещения большого пальца вверх на выбранном аватаре.

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.biz/rest/api/thumbs-down-avatar
Operation: POST
Type: XML
API аватара с большим пальцем вниз, используемый для размещения большого пальца вниз к выбранному аватару.

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

Домен URL-адреса конечных точек

Get-Domains

URI: https://www.botlibre.biz/rest/api/get-domains
Operation: POST
Type: XML
API get-domains, используемый для извлечения всех доступных доменов.

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.biz/rest/api/get-domain-users
Operation: POST
Type: XML
API get-domain-users, используемый для извлечения всех пользователей домена.

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.biz/rest/api/get-domain-admins
Operation: POST
Type: XML
API get-domain-admins, используемый для извлечения всех администраторов домена.

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.biz/rest/api/get-domain
Operation: POST
Type: XML
API get-domain извлекает выбранный домен.

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.biz/rest/api/get-domain-icon
Operation: POST
Type: XML
API get-domain-icon, используемый для возврата значка домена.

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.biz/rest/api/create-domain
Operation: POST
Type: XML
API создания домена — это новый домен.

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.biz/rest/api/check-domain
Operation: POST
Type: XML
API контрольного домена, используемый для проверки и возврата домена обратно.

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.biz/rest/api/update-domain
Operation: POST
Type: XML
API домена обновления обновляет содержимое домена.

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.biz/rest/api/delete-domain
Operation: POST
Type: XML
API удаления домена удаляет выбранный домен.

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.biz/rest/api/flag-domain
Operation: POST
Type: XML
API домена флага, используемый для пометки домена.

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.biz/rest/api/star-domain
Operation: POST
Type: XML
API звездного домена, используемый для размещения звездочки в домене.

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.biz/rest/api/thumbs-up-domain
Operation: POST
Type: XML
API большого пальца вверх по домену, используемый для увеличения размера домена.

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.biz/rest/api/thumbs-down-domain
Operation: POST
Type: XML
API домена thumbs-down-down, используемый для больших пальцев вниз к выбранному домену.

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

Графика URL-адреса конечных точек

Get-Graphics

URI: https://www.botlibre.biz/rest/api/get-graphics
Operation: POST
Type: XML
API get-graphics извлекает всю доступную графику.

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.biz/rest/api/get-graphic-users
Operation: POST
Type: XML
API get-graphic-users возвращает всех пользователей выбранного графического объекта.

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.biz/rest/api/get-graphic-admins
Operation: POST
Type: XML
API get-graphic-admins возвращает всех администраторов выбранного графического объекта.

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.biz/rest/api/update-graphic
Operation: POST
Type: XML
API обновления графики, используемый для обновления содержимого графического объекта.

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.biz/rest/api/update-graphic-icon
Operation: POST
Type: XML
API update-graphic-icon, используемый для изменения и обновления графического значка.

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.biz/rest/api/update-graphic-media
Operation: POST
Type: XML
API update-graphic-media, используемый для обновления мультимедийного содержимого выбранного графического объекта.

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.biz/rest/api/create-graphic
Operation: POST
Type: XML
API создания графики, используемый для создания нового графического объекта.

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.biz/rest/api/delete-graphic
Operation: POST
Type: XML
API удаления графики, используемый для удаления выбранного графического объекта.

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.biz/rest/api/check-graphic
Operation: POST
Type: XML
КОНТРОЛЬНО-графический API, используемый для проверки рисунка и возврата его обратно.

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.biz/rest/api/flag-graphic
Operation: POST
Type: XML
ФЛАГ-графический API, используемый для пометки графического объекта.

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.biz/rest/api/star-graphic
Operation: POST
Type: XML
API звездной графики, используемый для размещения звездочки на графике.

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.biz/rest/api/thumbs-up-graphic
Operation: POST
Type: XML
API эскизов вверх-графики, используемый для размещения большого пальца вверх на выбранном графическом объекте.

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.biz/rest/api/thumbs-down-graphic
Operation: POST
Type: XML
API эскизов вниз-графики, используемый для размещения большого пальца вниз к выбранному графическому объекту.

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

Аналитика конечных точек URL

Get-Analytics

URI: https://www.botlibre.biz/rest/api/get-analytics
Operation: POST
Type: XML
API get-analytics, используемый для извлечения всей доступной аналитики.

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.biz/rest/api/get-analytic-users
Operation: POST
Type: XML
API get-analytic-users, используемый для извлечения всех пользователей аналитики.

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.biz/rest/api/get-analytic-admins
Operation: POST
Type: XML
API get-analytic-admins, используемый для извлечения всех администраторов выбранной аналитики.

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.biz/rest/api/test-analytic
Operation: POST
Type: XML
Тест-аналитический API, используемый для тестирования обученной аналитической модели с конкретными инструкциями.

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.biz/rest/api/test-audio-analytic
Operation: POST
Type: XML
Test-audio-analytic API, используемый для тестирования аналитической аудиомодели.

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.biz/rest/api/test-object-detection-analytic
Operation: POST
Type: XML
API test-object-detection-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
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.biz/rest/api/get-test-media-result
Operation: POST
Type: XML
API get-test-media-result извлекает результаты тестового носителя.

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.biz/rest/api/report-media-analytic
Operation: POST
Type: XML
API report-media-analytic, используемый для получения аналитического воспроизведения.

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.biz/rest/api/train-analytic
Operation: POST
Type: XML
ОБУЧАЮЩИЙ АНАЛИТИЧЕСКИЙ API, используемый для обучения аналитической модели.

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.biz/rest/api/delete-analytic-media
Operation: POST
Type: XML
API delete-analytic-media, используемый для удаления выбранного аналитического носителя.

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.biz/rest/api/delete-analytic-test-media
Operation: POST
Type: XML
API delete-analytic-test-media, используемый для удаления тестового носителя аналитики.

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.biz/rest/api/get-analytic-media
Operation: POST
Type: XML
API get-analytic-media, используемый для извлечения всех аналитических носителей.

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.biz/rest/api/get-analytic-test-media
Operation: POST
Type: XML
API get-analytic-test-media извлекает тестовый носитель аналитики.

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.biz/rest/api/create-analytic-label
Operation: POST
Type: XML
Create a label or labels for an Analytic. Each label is a classifier. Each label is like a package will contain a set of images. This is required before starting the training phase for image recognition. Each Analytic must at least has two labels.

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.biz/rest/api/create-analytic-test-media-label
Operation: POST
Type: XML
Create a label or labels for an Analytic. Each label is a classifier. Each label is like a package will contain a set of images. This is required before starting the training phase for image recognition. Each Analytic must at least has two labels.

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.biz/rest/api/delete-analytic-label
Operation: POST
Type: XML
API delete-analytic-label, используемый для удаления выбранной метки аналитического объекта.

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.biz/rest/api/delete-analytic-test-media-label
Operation: POST
Type: XML
API delete-analytic-test-media-label, используемый для удаления метки тестового носителя аналитики.

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.biz/rest/api/check-training
Operation: POST
Type: XML
API контрольного обучения, используемый для извлечения некоторой информации о текущем обучении модели.

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.biz/rest/api/create-analytic
Operation: POST
Type: XML
API создания-аналитики создает новый Аналитический.

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.biz/rest/api/update-analytic
Operation: POST
Type: XML
Обновление API аналитики обновлений или изменение сведений о выбранной аналитике.

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.biz/rest/api/flag-analytic
Operation: POST
Type: XML
API-анализ флага, используемый для размещения флага в Analytic.

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.biz/rest/api/thumbs-up-analytic
Operation: POST
Type: XML
Аналитический API, используемый для создания большого пальца для создания большого пальца для аналитики.

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.biz/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
Аналитический API thumbs-down-down, используемый для больших пальцев вниз к Analytic.

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.biz/rest/api/star-analytic
Operation: POST
Type: XML
Звездно-аналитический API используется для звездообразования аналитического объекта.

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.biz/rest/api/delete-analytic
Operation: POST
Type: XML
API delete-analyic, используемый для удаления выбранной аналитики.

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.biz/rest/api/check-analytic
Operation: POST
Type: XML
Контрольно-аналитический API, используемый для проверки экземпляра аналитики и его возврата.

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.biz/rest/api/reset-data-analytic
Operation: POST
Type: XML
API анализа остальных данных, используемый для отдыха данных выбранного аналитика.

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

Test-Data-Analytic

URI: https://www.botlibre.biz/rest/api/test-data-analytic
Operation: POST
Type: XML
Проверьте аналитические данные с помощью одного набора входных данных.

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.

Пример

Test

Пример Результата

Train-Data-Analytic

URI: https://www.botlibre.biz/rest/api/train-data-analytic
Operation: POST
Type: XML
Обучить аналитические данные нескольким наборам входных данных и выходов.

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.

Пример

Test

Вы можете вызвать любой из вышеуказанных API с помощью JSON вместо XML с помощью конечной точки /rest/json Вместо /rest/api.

См. Также

• Бот Либре чат веб-бот АПИ
• Консоль веб-API