Веб-API

Virtual Dream Chat основан на платформе Bot Libre с открытым исходным кодом.

В дополнение к возможности для размещения своего чата ботов на свой сайт, и открыть их с любого устройства 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	POST	XML	Deleting a selected bot.
/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
/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/edit-instance	POST	XML	Edit bot instance.
/rest/api/delete-instance	POST	XML	Delete current 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

Форум по 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-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-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/save-bot-avatar	POST	XML	Choose an avatar and save for a bot.
/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
/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://virtualdreamchat.com/rest/api/form-chat
Operation: GET
Type: Form
Форме-чат API получает сообщение и возвращает ответ в чат бота как XML-документ.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
instance			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			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			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			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			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			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			A boolean that defines the chat message is a correction to the bot's last answer.
offensive			A boolean that defines the bot's last answer as offensive. The message will be flagged for the bot's administrator to review.
disconnect			A boolean that defines the end of the conversation.
includeQuestion			A boolean that indicates the question should be included in the response.

Пример

Test

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

XML Chat

URI: https://virtualdreamchat.com/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://virtualdreamchat.com/rest/json/chat
Operation: POST
Type: JSON

Parameters

Parameter	Required	Type	Description

Test

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

Form-Check-User

URI: https://virtualdreamchat.com/rest/api/form-check-user
Operation: GET
Type: Form
Форму-регистрация пользователей API для проверки пользователя, и возвращает данные пользователя.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user			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			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://virtualdreamchat.com/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://virtualdreamchat.com/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			Filter all the private bot items.
filteradult			Filter all adult bot items.
type			Type of bot.
typefilter			Filter type of bot.
userfilter			Filter by users.

Test

Get-Bot-Script-Source

URI: https://virtualdreamchat.com/rest/api/get-bot-script-source
Operation: POST
Type: XML
API get-bot-script-source, используемый для получения исходного кода скрипта.

Parameters

Parameter	Required	Type	Description

Test

Delete-Bot

URI: https://virtualdreamchat.com/rest/api/delete-bot
Operation: POST
Type: XML
API удаления-бота удаляет выбранного бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Bot id for validation.
user		attribute	The ID of the user who is deleting the bot. 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-Bot-Script

URI: https://virtualdreamchat.com/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	Bot id for validation.
user		attribute	The ID of the user who is deleting the bot. 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.
script			Bot script to be deleted.

Test

Import-Bot-Script

URI: https://virtualdreamchat.com/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	Bot id for validation.
user		attribute	The ID of the user who is deleting the bot. 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.
script			Bot script to be imported.

Test

Import-Bot-Log

URI: https://virtualdreamchat.com/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	Bot id for validation.
user		attribute	The ID of the user who is deleting the bot. 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.
log			Bot logs to be imported.

Test

Save-Bot-Avatar

URI: https://virtualdreamchat.com/rest/api/save-bot-avatar
Operation: POST
Type: XML
API save-bot-avatar используется для выбора аватара и сохранения для бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Bot-Script-Source

URI: https://virtualdreamchat.com/rest/api/save-bot-script-source
Operation: POST
Type: XML

Parameters

Parameter	Required	Type	Description

Test

Create-Bot-Attachment

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

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
id			An id of the forum for validation.
user		attribute	The ID of the user who is creating the bot attachemnt. 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.
attachment			Bot attachemnt.

Test

Up-Bot-Script

URI: https://virtualdreamchat.com/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	Bot id for validation.
user		attribute	The ID of the user who is checking instance admins. 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.
script			The selected script to be moved up.

Test

Down-Bot-Script

URI: https://virtualdreamchat.com/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	Bot id for validation.
user		attribute	The ID of the user who is checking instance admins. 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.
script			The selected script to be moved down.

Test

Get-Instances

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

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Instances id for validation.
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.
media			Media.
filename			File name of the instance.
filetype			Type of the instance.
filterprivate			Filter all the private instance items.
filteradult			Filter all adult instance items.
type			Type of instance.
typefilter			Filter type of instance.
userfilter			Filter by users.
tag			Tag of instance.
category			Category of instance.
contentrating			Instances based on content rating.
restrict			All instance with restriction.
sort			Sort instances.

Test

Get-Instance-Users

URI: https://virtualdreamchat.com/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	Instance id for validation.
user		attribute	The ID of the user who is getting the users in from the instance. 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-Instance-Admins

URI: https://virtualdreamchat.com/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	Instance id for validation.
user		attribute	The ID of the user who is checking instance admins. 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-All-Instances

URI: https://virtualdreamchat.com/rest/api/get-all-instances
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 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

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

Check-Instance

URI: https://virtualdreamchat.com/rest/api/check-instance
Operation: POST
Type: XML
Регистрация экземпляра API проверяет, существует ли бот ID или Name, и возвращает данные бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	The ID of the bot to validate. The bot's name can also be used, but the ID is better as it is guaranteed to be unique.
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://virtualdreamchat.com/rest/api/form-check-instance
Operation: GET
Type: Form
Форму-Регистрация экземпляра API проверяет, существует ли бот ID или Name, и возвращает данные бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	The ID of the bot to validate. The bot's name can also be used, but the ID is better as it is guaranteed to be unique.
name			The name of the bot to validate. The bot's ID can also be used.
user			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			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://virtualdreamchat.com/rest/api/form-get-all-instances
Operation: GET
Type: Form
Форме-вам-все-случаи АПИ запрашивает данные для всех бот экземпляров.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user			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			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			The tag to filter the bots by.
sort			The sort option for the query. One of "name", "date", "dailyConnects", "weeklyConnects", "monthlyConnects".
filterprivate			Set if only the user's private bots should be returned.

Пример

Test

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

Update-Instance

URI: https://virtualdreamchat.com/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 who is creating the instance. The user must be registered with Bot Libre.
workspace			Workspace for a bot.
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.
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.
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 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

Update-Instance-Icon

URI: https://virtualdreamchat.com/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	Instance id for validation.
user		attribute	The ID of the user who is updating instance icon. 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.
image-icon		img	Update instance icon

Test

Create-Instance

URI: https://virtualdreamchat.com/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 who is creating the instance. The user must be registered with Bot Libre.
template			Type of bot to create.
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.
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

Edit-Instance

URI: https://virtualdreamchat.com/rest/api/edit-instance
Operation: POST
Type: XML
API экземпляра редактирования для редактирования и обновления экземпляра бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user who is creating the instance. The user must be registered with Bot Libre.
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.
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://virtualdreamchat.com/rest/api/delete-instance
Operation: POST
Type: XML
API удаления экземпляра для удаления экземпляра бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Instance id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/flag-instance
Operation: POST
Type: XML
API экземпляра флага Пометить экземпляр бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Instance id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Instance

URI: https://virtualdreamchat.com/rest/api/star-instance
Operation: POST
Type: XML
API звездного экземпляра помекрает экземпляр бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Instance id for validation.
user		attribute	The ID of the user who wants to star the instance. 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

Train-Instance

URI: https://virtualdreamchat.com/rest/api/train-instance
Operation: POST
Type: XML
API обучающего экземпляра обучает экземпляр чат-бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Instance id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Instance

URI: https://virtualdreamchat.com/rest/api/thumbs-up-instance
Operation: POST
Type: XML
API экземпляра thumbs-up-instance, в который пользователь может поместить большой палец вверх к экземпляру чат-бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Instance id for validation.
user		attribute	The ID of the user who is placing a thumbs up on the instance. 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://virtualdreamchat.com/rest/api/thumbs-down-instance
Operation: POST
Type: XML
Экземпляр большого пальца вниз, который пользователь может поместить в экземпляр чат-бота

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Instance id for validation.
user		attribute	The ID of the user who is placing a thumbs down on an instance. 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://virtualdreamchat.com/rest/api/get-forums
Operation: POST
Type: XML
API get-forums, используемый для получения доступных форумов.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Instance id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Posts

URI: https://virtualdreamchat.com/rest/api/get-forum-posts
Operation: POST
Type: XML
API get-forum-posts, используемый для получения доступных сообщений каждого форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Instance id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Users

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is getting the users in the forum. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is checking forum admins. 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://virtualdreamchat.com/rest/api/save-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter	Required	Type	Description

Test

Get-Forum-Bot-Mode

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

Parameters

Parameter	Required	Type	Description

Test

Create-Forum

URI: https://virtualdreamchat.com/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 who is creating the forum. 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.
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).
post-mode			Who can post on the forum.
post-reply-mode			Who can reply to a post in the forum.

Test

Create-Forum-Attachment

URI: https://virtualdreamchat.com/rest/api/create-forum-attachment
Operation: POST
Type: XML
API создания-форума-вложения для создания форума, содержащего вложение.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
id			An id of the forum for validation.
user		attribute	The ID of the user who is creating the forum. 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.
attachment			Forum attachemnt.

Test

Create-Forum-Post

URI: https://virtualdreamchat.com/rest/api/create-forum-post
Operation: POST
Type: XML
API create-forum-post для создания нового сообщения для форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
id			An id of the forum for validation.
user		attribute	The ID of the user who is creating the forum. 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
details			Type of a markup
body			Test Area
tags			Tags
subscribe-replies		boolean	Subscribe to this post to be notified once a reply is posted

Test

Update-Forum

URI: https://virtualdreamchat.com/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 who is updating the forum. The user must be registered with Bot Libre.
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.
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).
post-mode			Who can post on the forum.
post-reply-mode			Who can reply to a post in the forum.

Test

Update-Forum-Post

URI: https://virtualdreamchat.com/rest/api/update-forum-post
Operation: POST
Type: XML
API update-forum-post обновляет содержимое сообщения форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
id			An id of the forum for validation.
user		attribute	The ID of the user who is creating the forum. 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
details			Type of a markup
body			Test Area
tags			Tags
subscribe-replies		boolean	Subscribe to this post to be notified once a reply is posted

Test

Update-Forum-Icon

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is updating forum icon. 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.
image-icon		img	Update forum icon

Test

Check-Forum

URI: https://virtualdreamchat.com/rest/api/check-forum
Operation: POST
Type: XML
API контрольного форума проверяет и возвращает форум.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/delete-forum
Operation: POST
Type: XML
API удаления форума для удаления форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/delete-forum-post
Operation: POST
Type: XML
API удаления-форума-сообщения — это сообщение форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/flag-forum
Operation: POST
Type: XML
API флаг-форум, используемый для пометки форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is placing a flag to a forum. 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-Post

URI: https://virtualdreamchat.com/rest/api/flag-forum-post
Operation: POST
Type: XML
Флаг API форума-сообщения — это сообщение форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is placing a flag to a forum post. 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-Forum

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is placing a thumbs up to a forum. 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://virtualdreamchat.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
API форума с большими пальцами вниз используется для размещения больших пальцев вниз к форуму.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is placing a thumbs down to a forum. 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://virtualdreamchat.com/rest/api/subscribe-forum
Operation: POST
Type: XML
API подписки на форум позволяет пользователю подписаться на форум.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML
API форума отписки позволяет пользователю отказаться от подписки на форум.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/star-forum
Operation: POST
Type: XML
API звездного форума позволяет пользователю поставить звездочку на форуме.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is placing a star to a forum. 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://virtualdreamchat.com/rest/api/get-forums
Operation: POST
Type: XML
API get-forums, используемый для получения доступных форумов.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
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			Filter all the private forum items.
filteradult			Filter all adult forum items.
type			Type of forum.
typefilter			Filter type of forum.
userfilter			Filter by users.

Test

Get-Forum-Posts

URI: https://virtualdreamchat.com/rest/api/get-forum-posts
Operation: POST
Type: XML
API get-forum-posts, используемый для получения доступных сообщений каждого форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Users

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is getting the users in the forum. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is checking forum admins. 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://virtualdreamchat.com/rest/api/save-forum-bot-mode
Operation: POST
Type: XML

Parameters

Parameter	Required	Type	Description

Test

Get-Forum-Bot-Mode

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

Parameters

Parameter	Required	Type	Description

Test

Create-Forum

URI: https://virtualdreamchat.com/rest/api/create-forum
Operation: POST
Type: XML
API create-forum используется для создания нового форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user who is creating the forum. 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.
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).
post-mode			Who can post on the forum.
post-reply-mode			Who can reply to a post in the forum.

Test

Create-Forum-Attachment

URI: https://virtualdreamchat.com/rest/api/create-forum-attachment
Operation: POST
Type: XML
API создания-форума-вложения для создания форума, содержащего вложение.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
id			An id of the forum for validation.
user		attribute	The ID of the user who is creating the forum. 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.
attachment			Forum attachemnt.

Test

Create-Forum-Post

URI: https://virtualdreamchat.com/rest/api/create-forum-post
Operation: POST
Type: XML
API create-forum-post для создания нового сообщения для форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
id			An id of the forum for validation.
user		attribute	The ID of the user who is creating the forum. 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
details			Type of a markup
body			Test Area
tags			Tags
subscribe-replies		boolean	Subscribe to this post to be notified once a reply is posted

Test

Update-Forum

URI: https://virtualdreamchat.com/rest/api/update-forum
Operation: POST
Type: XML
API update-forum, используемый для обновления содержимого форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	The ID of forum for validation.
user		attribute	The ID of the user who is creating the forum. 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.
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.
workspace			Name of the workspace.
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.
website-subdomain		attribute	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 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).
post-mode			Who can post on the forum.
post-reply-mode			Who can reply to a post in the forum.

Test

Update-Forum-Post

URI: https://virtualdreamchat.com/rest/api/update-forum-post
Operation: POST
Type: XML
API update-forum-post обновляет содержимое сообщения форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID
id			An id of the forum for validation.
user		attribute	The ID of the user who is creating the forum. 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
details			Type of a markup
body			Test Area
tags			Tags
featured		boolean	For featured posts.

Test

Update-Forum-Icon

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is updating forum icon. 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.
image-icon		img	Update forum icon

Test

Check-Forum

URI: https://virtualdreamchat.com/rest/api/check-forum
Operation: POST
Type: XML
API контрольного форума проверяет и возвращает форум.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/delete-forum
Operation: POST
Type: XML
API удаления форума для удаления форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/delete-forum-post
Operation: POST
Type: XML
API удаления-форума-сообщения — это сообщение форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/flag-forum
Operation: POST
Type: XML
API флаг-форум, используемый для пометки форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is placing a flag to a forum. 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-Post

URI: https://virtualdreamchat.com/rest/api/flag-forum-post
Operation: POST
Type: XML
Флаг API форума-сообщения — это сообщение форума.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Forum

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is placing a thumbs up to a forum. 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://virtualdreamchat.com/rest/api/thumbs-down-forum
Operation: POST
Type: XML
API форума с большими пальцами вниз используется для размещения больших пальцев вниз к форуму.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/subscribe-forum
Operation: POST
Type: XML
API подписки на форум позволяет пользователю подписаться на форум.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is unsubscribing to a forum. 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://virtualdreamchat.com/rest/api/unsubscribe-forum
Operation: POST
Type: XML
API форума отписки позволяет пользователю отказаться от подписки на форум.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is unsubscribing to a forum. 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://virtualdreamchat.com/rest/api/star-forum
Operation: POST
Type: XML
API звездного форума позволяет пользователю поставить звездочку на форуме.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Forum id for validation.
user		attribute	The ID of the user who is unsubscribing to a forum. 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://virtualdreamchat.com/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 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			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.

Test

Get-Avatar-Users

URI: https://virtualdreamchat.com/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	avatars id for validation.
user		attribute	The ID of the user who is getting the users in the avatar. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is checking avatar admins. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/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 who is creating the avatar. 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.
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			Brief description for the avatar.
details			Details for the avatar.
disclaimer			Disclaimer regarding the new avatar.
license			License to release the avatar and all its content under.
website			URL for the avatar if it has it's own website.
categories			On what category would you place your avatar. Must select at least one of the categories. (People, 3D, Video, MP4).
tags			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://virtualdreamchat.com/rest/api/create-avatar-media
Operation: POST
Type: XML
API create-avatar-media, используемый для создания мультимедиа для аватара.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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.
media			New avatar media to be uploaded.

Test

Save-Avatar-Media

URI: https://virtualdreamchat.com/rest/api/save-avatar-media
Operation: POST
Type: XML
API save-avatar-media, используемый для сохранения изменений текущего мультимедиа аватара.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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.
media			Avatar selected media to be saved.

Test

Save-Avatar-Background

URI: https://virtualdreamchat.com/rest/api/save-avatar-background
Operation: POST
Type: XML
API сохранения-аватара-фона сохраняет фоновое изображение аватара.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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.
background			Avatar background to be saved.

Test

Save-Bot-Avatar

URI: https://virtualdreamchat.com/rest/api/save-bot-avatar
Operation: POST
Type: XML
API save-bot-avatar используется для выбора аватара и сохранения для бота.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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

URI: https://virtualdreamchat.com/rest/api/delete-avatar
Operation: POST
Type: XML
API удаления аватара, используемый для удаления выбранного аватара.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/delete-avatar-media
Operation: POST
Type: XML
API delete-avatar-media, используемый для удаления мультимедиа аватара.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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.
media			Avatar selected media to be deleted.

Test

Delete-Avatar-Background

URI: https://virtualdreamchat.com/rest/api/delete-avatar-background
Operation: POST
Type: XML
API удаления-аватара-фона, используемый для удаления фонового изображения аватара.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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.
background			Background image of an avatar.

Test

Check-Avatar

URI: https://virtualdreamchat.com/rest/api/check-avatar
Operation: POST
Type: XML
API check-avatar используется для проверки и возврата аватара.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/avatar-message
Operation: POST
Type: XML
API аватар-сообщения

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user			User who has access to modify the Analytic.
password			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			Message.

Test

Star-Avatar

URI: https://virtualdreamchat.com/rest/api/star-avatar
Operation: POST
Type: XML
API звездного аватара, используемый для того, чтобы пользователь использовал аватар.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Avatar

URI: https://virtualdreamchat.com/rest/api/flag-avatar
Operation: POST
Type: XML
API флаг-аватар, используемый для пометки аватара.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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

Init-Avatar

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

Parameters

Parameter	Required	Type	Description

Test

Update-Avatar

URI: https://virtualdreamchat.com/rest/api/update-avatar
Operation: POST
Type: XML
API update-avatar, используемый для обновления и изменения содержимого аватара.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
user		attribute	The ID of the user who is creating the avatar. 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.
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			Brief description for the avatar.
details			Details for the avatar.
disclaimer			Disclaimer regarding the new avatar.
license			License to release the avatar and all its content under.
website			URL for the avatar if it has it's own website.
categories			On what category would you place your avatar. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags			Tags for your avatar
isPrivate		attribute	Instance can be private, and accessed only by the user.
isHidden		attribute	Hidden avatar will not be available to public.
accessMode		attribute	Domain 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).
creation-mode			Who can create channels, forums, bots in this avatar.

Test

Update-Avatar-Icon

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is updating avatar icon. 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.
image-icon		img	Update avatar icon

Test

Thumbs-Up-Avatar

URI: https://virtualdreamchat.com/rest/api/thumbs-up-avatar
Operation: POST
Type: XML
API «большой палец вверх-аватар», используемый для размещения большого пальца вверх на выбранном аватаре.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/thumbs-down-avatar
Operation: POST
Type: XML
API аватара с большим пальцем вниз, используемый для размещения большого пальца вниз к выбранному аватару.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Avatar id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/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 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			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.

Test

Get-Domain-Users

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is getting the users in the domain. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is checking the domain admins. 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://virtualdreamchat.com/rest/api/get-domain
Operation: POST
Type: XML
API get-domain извлекает выбранный домен.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is updating domain's icon. 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://virtualdreamchat.com/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 who is creating the domain. 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.
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).
creation-mode			Who can create channels, forums, bots in this domain.

Test

Check-Domain

URI: https://virtualdreamchat.com/rest/api/check-domain
Operation: POST
Type: XML
API контрольного домена, используемый для проверки и возврата домена обратно.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/update-domain
Operation: POST
Type: XML
API домена обновления обновляет содержимое домена.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	domain id for validation.
user		attribute	The ID of the user who is updating the domain. 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.
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).
creation-mode			Who can create channels, forums, bots in this domain.

Test

Delete-Domain

URI: https://virtualdreamchat.com/rest/api/delete-domain
Operation: POST
Type: XML
API удаления домена удаляет выбранный домен.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/flag-domain
Operation: POST
Type: XML
FALG-domain API, используемый для пометки домена.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Domain

URI: https://virtualdreamchat.com/rest/api/star-domain
Operation: POST
Type: XML
API звездного домена, используемый для размещения звезды в домене.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Domain

URI: https://virtualdreamchat.com/rest/api/thumbs-up-domain
Operation: POST
Type: XML
API большого пальца вверх по домену, используемый для создания большого пальца вверх домена.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Domain id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/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 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			Filter all the private graphic items.
filteradult			Filter all adult grapic items.
type			Type of graphic.
typefilter			Filter type of graphic.
userfilter			Filter by users.

Test

Get-Graphic-Users

URI: https://virtualdreamchat.com/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 id for validation.
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.
media			Media.
filename			File name of the graphic.
filetype			Type of the graphic.

Test

Get-Graphic-Admins

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is checking graphic admins. 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://virtualdreamchat.com/rest/api/update-graphic
Operation: POST
Type: XML
API обновления графики, используемый для обновления содержимого графического объекта.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id			id to validate a graphic.
user		attribute	The ID of the user who is updating the graphic. The user must be registered with Bot Libre.
password		attribute	The password of the user who is updating the graphic.
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			Brief description for the graphic.
details			Details for the graphic.
disclaimer			Disclaimer regarding the new graphic.
license			License to release the graphic and all its content under.
website			URL for the graphic if it has it's own website.
categories			On what category would you place your graphic. Must select at least one of the categories. (Image, Audio, Data, Misc).
tags			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).

Test

Update-Graphic-Icon

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is updating graphic icon. 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.
image-icon		img	Update graphic icon

Test

Update-Graphic-Media

URI: https://virtualdreamchat.com/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 who is creating the domain. The user must be registered with Bot Libre.
id		attribute	graphic id for validation.
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.

Test

Create-Graphic

URI: https://virtualdreamchat.com/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 who is creating the graphic. 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.
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			Brief description for the graphic.
details			Details for the graphic.
disclaimer			Disclaimer regarding the new graphic.
license			License to release the graphic and all its content under.
website			URL for the graphic if it has it's own website.
categories			On what category would you place your graphic. Must select at least one of the categories. (Bot Libre, Web, Education, Misc).
tags			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).
creation-mode			Who can create channels, forums, bots in this graphic.

Test

Delete-Graphic

URI: https://virtualdreamchat.com/rest/api/delete-graphic
Operation: POST
Type: XML
API удаления графики, используемый для удаления выбранного графического объекта.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/check-graphic
Operation: POST
Type: XML
API контрольной графики, используемый для проверки рисунка и возврата его обратно.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/flag-graphic
Operation: POST
Type: XML
API-флаг-графика, используемый для пометки графического объекта.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Graphic

URI: https://virtualdreamchat.com/rest/api/star-graphic
Operation: POST
Type: XML
API звездной графики, используемый для размещения звезды на графике.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Graphic

URI: https://virtualdreamchat.com/rest/api/thumbs-up-graphic
Operation: POST
Type: XML
API «палец вверх-графика», используемый для размещения большого пальца вверх на выбранном графическом объекте.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/thumbs-down-graphic
Operation: POST
Type: XML
API эскизов вниз-графики, используемый для размещения большого пальца вниз к выбранному графическому объекту.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Graphic id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/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 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			Filter all the private analytic items.
filteradult			Filter all adult analytic items.
type			Type of analytics.
typefilter			Filter type of analytic.
userfilter			Filter by users.
tag			Tag of analytic.
category			Category of analytic.

Test

Get-Analytic-Users

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is getting the users in the analytic. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is checking analytic admins. 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://virtualdreamchat.com/rest/api/test-analytic
Operation: POST
Type: XML
Тест-аналитический API, используемый для тестирования обученной аналитической модели с конкретными инструкциями.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
image			The image as input to be recognized.
name			The name of the bot to validate. The bot's ID can also be used.
user			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			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-Audio-Analytic

URI: https://virtualdreamchat.com/rest/api/test-audio-analytic
Operation: POST
Type: XML
Тест-аудио-аналитический API, используемый для тестирования аналитической аудиомодель.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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.
audio			Audio file needed to audio recognize.

Test

Test-Object-Detection-Analytic

URI: https://virtualdreamchat.com/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.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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.
image			An image needed to object detect.

Test

Get-Test-Media-Result

URI: https://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is flag the instance. 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

Train-Analytic

URI: https://virtualdreamchat.com/rest/api/train-analytic
Operation: POST
Type: XML
API обучения аналитики, используемый для обучения аналитической модели.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Analytic-Media

URI: https://virtualdreamchat.com/rest/api/delete-analytic-media
Operation: POST
Type: XML
API delete-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 who is flag the instance. 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-Analytic-Test-Media

URI: https://virtualdreamchat.com/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.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Media

URI: https://virtualdreamchat.com/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 who is flag the instance. 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://virtualdreamchat.com/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 id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/create-analytic-label
Operation: POST
Type: XML
Создайте метку или метки для аналитического. Каждая метка является классификатором. Каждая этикетка как бы упаковка будет содержать набор изображений. Это необходимо перед началом этапа обучения распознаванию изображений. Каждый аналитик должен иметь как минимум две метки.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user			User who has access to modify the Analytic.
password			Password of the user.
token		attribute	The token of the user. A token can be obtained through check-user, and is valid until reset.
analytic-label			label or a name to classify a specific image, and will contain all the images of the same object.

Test

Create-Analytic-Test-Media-Label

URI: https://virtualdreamchat.com/rest/api/create-analytic-test-media-label
Operation: POST
Type: XML
Создайте метку или метки для аналитического. Каждая метка является классификатором. Каждая этикетка как бы упаковка будет содержать набор изображений. Это необходимо перед началом этапа обучения распознаванию изображений. Каждый аналитик должен иметь как минимум две метки.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user			User who has access to modify the Analytic.
password			Password of the user.
analytic-label			label or a name to classify a specific image, and will contain all the images of the same object.

Test

Delete-Analytic-Label

URI: https://virtualdreamchat.com/rest/api/delete-analytic-label
Operation: POST
Type: XML
API delete-analytic-label, используемый для удаления выбранной метки аналитического объекта.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user			User who has access to modify the Analytic.
password			Password of the user.
analytic-label			label or a name to classify a specific image, and will contain all the images of the same object.

Test

Delete-Analytic-Test-Media-Label

URI: https://virtualdreamchat.com/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.
id		attribute	Analytic id for validation.
user			User who has access to modify the Analytic.
password			Password of the user.
analytic-label			label or a name to classify a specific image, and will contain all the images of the same object.

Test

Check-Training

URI: https://virtualdreamchat.com/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 who is creating the analytic. 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.
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.

Test

Create-Analytic

URI: https://virtualdreamchat.com/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 who is creating the analytic. 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.
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			Brief description for the Analytic.
details			Details for the Analytic.
disclaimer			Disclaimer regarding the new Analytic.
license			License to release the Analytic and all its content under.
website			URL for the Analytic if it has it's own website.
categories			On what category would you place your Analytic. Must select at least one of the categories. (Image, Audio, Data, Misc).
tags			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).
contentRating		attribute	Analytic can be viewed or rated for (Everyone, Teen, Mature).

Test

Update-Analytic

URI: https://virtualdreamchat.com/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 who is creating the analytic. The user must be registered with Bot Libre.
password		attribute	The password of the user who is creating the analytic.
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			Brief description for the Analytic.
details			Details for the Analytic.
disclaimer			Disclaimer regarding the new Analytic.
license			License to release the Analytic and all its content under.
website			URL for the Analytic if it has it's own website.
categories			On what category would you place your Analytic. Must select at least one of the categories. (Image, Audio, Data, Misc).
tags			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).

Test

Flag-Analytic

URI: https://virtualdreamchat.com/rest/api/flag-analytic
Operation: POST
Type: XML
API-анализ флага, используемый для размещения флага в Analytic.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Analytic

URI: https://virtualdreamchat.com/rest/api/thumbs-up-analytic
Operation: POST
Type: XML
Аналитический API thumbs-up-analytic используется для создания большого пальца для аналитики.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/thumbs-down-analytic
Operation: POST
Type: XML
Аналитический API, используемый для больших пальцев вниз к Analytic.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/star-analytic
Operation: POST
Type: XML
Звездно-аналитический API используется для звездописи аналитического объекта.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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-Analytic

URI: https://virtualdreamchat.com/rest/api/delete-analytic
Operation: POST
Type: XML
API delete-analyic, используемый для удаления выбранной аналитики.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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://virtualdreamchat.com/rest/api/check-analytic
Operation: POST
Type: XML
Контрольно-аналитический API, используемый для проверки экземпляра аналитического и его возврата.

Parameters

Parameter	Required	Type	Description
application		attribute	Your application ID.
id		attribute	Analytic id for validation.
user		attribute	The ID of the user who is flag the instance. 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

Reset-Data-Analytic

URI: https://virtualdreamchat.com/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. 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.

Пример

Test

Test-Data-Analytic

URI: https://virtualdreamchat.com/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. 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.
input		element	A comma-seperated list of floats to be tested as input.

Пример

Test

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

Train-Data-Analytic

URI: https://virtualdreamchat.com/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.
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