Документация к боту ВКонтакте

Документация к боту ВКонтакте

Homework - helperBot

 

Оглавление

О Homework-helperBot 3

Получение информации от бота. 4

Основная структура сообщения. 4

Получение информации о погоде. 6

Получение «биржевой сводки». 8

Публикация материалов с помощью бота. 9

Публикация. 9

Разрешение доступа к материалу. 10

Запрет доступа к материалу. 11

Удаление. 12

«Список доверия». 13

Общая информация. 13

ID пользователей. 14

Работа со «списком доверия». 15

Бонусы от бота. 16

«Быстрая» клавиатура. 17

Список допустимых вариаций. 18

Задания. 18

Дата*. 19

Предметы*. 20

 

ОHomework-helperBot

Данный бот предназначен для того, чтобы обеспечить постоянную коммуникацию учащихсяпо вопросам, касающимся учёбы. С помощью него можно публиковать и читать материалы одноклассников, а также получать официальное домашнее задание, заполненное учителем. В функционал бота также включены несколько бытовых команд для удобства пользователя.

Приятного пользования и

хорошей учёбы!

              Получение информации от бота

Основная структура сообщения

Сообщение боту для получения какой-либо информации (кроме информации о погоде и биржевой сводки) должно начинаться с команды из следующего списка:

· Скинь

· Пришли

· Дай

Далее следует так называемое «задание» (или несколько «заданий»), то есть указание названия основного раздела, к которому относится интересующая Вас информация:

· Домашнее задание

· Ответ (или же решение)

· Конспект

· Документация

· Анекдот

У каждого из этих названий разделов есть свой список допустимых (то есть понятных боту) вариаций. Мы рекомендуем Вам не отступать от него. В противном случае бот Вас просто не поймёт.

После «задания»(дальнейшая структура сообщения не используется в случае с запросом документации или анекдота) в сообщении указывается дата, к которой относится интересующая Вас информация. Также возможен и список дат. Формат даты описан здесь.

Затем указывается школьный предмет (или несколько предметов), по которому Вам нужна информация. Возможные названия предметов описаны в «списке…». Если этот пункт опущен, бот выдаст всю информацию зауказанный период.

Вы также можете поменять местами дату и название предмета, но рекомендуется не отступать от приведённого выше протокола запроса информации.

Кроме официальной информации, бот пришлёт Вам в ответ ещё и доступные для Вас материалы других пользователей (если они выложены). Мы ненесём ответственности за правильность этих данных, но если вы замечаете ошибку, вы можете сообщить о ней в техническую поддержку (кнопка на «быстрой» клавиатуре).

Пример текста сообщения

Для получения информации от бота

(основная структура)

Получение информации о погоде

Бот может прислать информацию о погоде текущего, а также двух следующих дней. Для того, чтобы её получить, Вам нужно в начале сообщения написать ключевое слово «погода», а затем указать за какой день Вы хотите получить информацию. День может принимать одно из трёх значений:

· Сегодня

· Завтра

· Послезавтра

В ответ бот пришлёт сообщение, в тексте которого будет описание погоды в Санкт-Петербурге на каждые 3 часа указанного Вами дня. Если Вас интересует погода текущего дня, то бот пришлёт Вам её, начиная со времени, когда был отправлен ответ.

Обращаем Ваше внимание, что данная опция доступна на «быстрой» клавиатуре.

Информация о погоде предоставляется сайтом «OpenWeatherMap».

 

Пример текста сообщения

Получение «биржевой сводки»

Для получения «биржевой сводки» Вам нужно указать в тексте сообщения ключевое слово «сводка» или воспользоваться кнопкой «Биржевая сводка» на «быстрой» клавиатуре.

Информация о курсах валют и ценах на металлы предоставляется сайтом «Центральный банк Российской Федерации», а цены на нефть ⸻ «U. S. EnergyInformationAdministration (EIA)».

Пример текста сообщения

Публикация материалов с помощью бота

Публикация

Структуры текстов сообщений при публикации материалов и получении информации (основная структура) различаются только первыми частями. Данный тип сообщений начинается со слов:

· Опубликовать

· Выложить

Далее следуете инструкции написания сообщения для получения информации (основная структура).К публикации не допускается документация.

Важно, что к своему сообщению Вы должны обязательно прикрепить фотографию в формате JPGили PNG или текстовый документ в формате TXT, DOC, DOCXили PDFс материалом, который Вы хотите выложить.

Если Вы не укажите в своём сообщении названия предмета, чтобы получить Ваш материал, другой пользователь должен будет написать сообщение так же без указания предмета. В этом случае Ваш материал будет находиться в общей папке указанного дня.

После того, как бот прочитает Ваше сообщение, Вам будут начислены бонусы, и по умолчанию опубликованныйматериалбудетдоступен (анонимно)всем пользователям, если Вы не укажите в конце сообщения ID тех пользователей, которым Вы ходите предоставить доступ к нему, или не настроите заранее «список доверия». Материалы будут доступны другим пользователям в течение 45 дней с той даты, к которой они относятся. Затем они будут автоматически удалены без списания бонусов. Когда это произойдёт Вам придёт сообщение от бота. При публикации анекдота бонусы не начисляются, и материал будет доступен всем пользователям вне зависимости от списка доверия (ID пользователей в конце сообщения не указывается).

При публикации материалов Вы автоматически принимаете на себя ответственность за те данные, к которым предоставляете доступ. При поступлении жалоб на Ваши данные, они будут изучены администратором сообщества, куда добавлен бот. Если пользователя уличают в частом введении в заблуждение других пользователей, отсылке боту спама, плагиате, попытках получитьдополнительные бонусыили какой-либо иной запрещённой деятельности, будут приняты соответствующие меры: пользователь добавляется в чёрный список отправителей и больше не сможет публиковать материалы, а в случае продолжения подобных действий, бот перестаёт отвечать на его сообщения.

Пример текста сообщения

Для публикации материала

Пример текста сообщения

Запрет доступа к материалу

Запрет доступа к материалу происходит аналогично его разрешению. Разница лишь в команде: в данном случае необходимо указать в начале текста сообщения «Запретить (доступ к)». Важно также, чтобы IDзапрещаемого пользователя было до введения запретав списке разращённых.

Пример текста сообщения

Удаление

Удаление материала отличается от его публикации только командой и тем, что в данном случае не нужно указывать ID пользователейи добавлять материал. Текст сообщения должен начинаться с ключевого слова «удалить». При удалении анекдота в конце сообщения необходимо указать выданный ботом при публикацииIDанекдота.

Вы можете удалить только то, что выложили сами.

При удалении с Вашего счёта списываются те бонусы, которые Вы получили, публикуя данный материал.

Пример текста сообщения

Для удаления материала

«Список доверия»

Общая информация

«Список доверия» ⸻ это ID тех пользователей, которым Вы по умолчанию разрешаете доступ к Вашим выложенным материалам. После его настройки, при публикации материалов, если Вы не указываете в сообщении, кому можно видеть Ваши данные, бот автоматически даёт эту возможность людям из «списка…». В противном случае, разрешение даётся только тем, кто указан в тексте сообщения.

IDпользователей

IDпользователям даёт приложение ВКонтакте. Оно представляет из себя число, меньшее 2000000 000. Чтобы узнать IDпользователя, скопируйте ссылку на него. Вставьте её в какой-нибудь текстовый редактор. Цифры после слова «id» являются тем, что Вы ищите. Если же вместо «id» и цифр после него в ссылке указано что-нибудь другое, попробуйте иной способ: откройте (если Вы используете для этого браузер, то это следует сделать в новой вкладке) любую фотографию на странице пользователя, ID которого Вы хотите узнать. Скопируйте ссылку (в браузере — ту, которую Вы только что открыли). Цифры в адресе ссылки после слова «photo»и до «_» являются «id» пользователя.

Работа со «списком доверия»

Есть 5 команд для работы со «списком доверия:

· *Посмотреть, или увидеть ⸻ показывает «список…».

· Добавить (в) ⸻ к уже находящимся в «списке…» ID добавляются новые, перечисленные в конце сообщения.

· Удалить (из) ⸻ из «списка…» удаляются ID, перечисленные в конце сообщения.

· *Очистить ⸻ из «списка…» удаляются все ID.

· Обновить ⸻ из «списка…» удаляются все ID, а затем записываются новые, перечисленные в конце сообщения.

*Данная команда доступна на «быстрой» клавиатуре.

После каждой из перечисленных команд следует дописать ключевую фразу «список доверия» (также допускается предлог), а если вы «обновляете» или «добавляете», то также необходимы ID пользователей, которые вы хотите добавить в «список…».

Пример текста сообщения

Бонусы от бота

За каждый публикуемый материал по определённому предмету бот начисляет Вам бонусы «спасибо». Это своеобразная благодарность других пользователей за представление им данных.

Сколько у Вас бонусов, Вы можете посмотреть, послав боту в сообщении ключевое слово «баланс» или воспользовавшись кнопкой «Посмотреть мой баланс» на «быстрой» клавиатуре. Изначально баланс всех пользователей равен 0.

Пример текста сообщения

Для запроса баланса

«Быстрая» клавиатура

«Быстрая» клавиатура состоит из кнопок, которые отправляют боту уже готовые фразы или переводят его по ссылке. Чтобы её открыть, нажмите на прямоугольник в правом конце виджета для отправкисообщения.

Все кнопки, кроме помеченных стрелочкой, Вы можете продублировать вручную при наборе текста сообщения. Нажав кнопку «Написать отзыв», Вы перейдёте по ссылке туда, где Вы сможете оставить свой отзыв о боте. С помощью кнопки «Написать в тех. Поддержку» Вы без отправки сообщения боту можете связаться с администратором.

Список допустимых вариаций

Задания

1. Домашнее задание:

a. Домашнее задание

b. Дз

c. Дом.зад.

d. Дом зад

e. Задание

f. Зад.

2. Ответ (решение):

a. Ответ

b. Отв

c. Отв.

d. Решение

e. Реш.

f. Реш

3. Конспект:

a. Конспект

b. Консп.

c. Консп

4. Документация:

a. Документация

b. Докум.

c. Докум

d. Инструкция

e. Инстр.

f. Инстр

5. Анекдот:

a. Анекдот

b. Анек.

c. Анек

d. Шутка

e. Мем

Дата*

1. Дд.мм.гггг

2. Дд.мм.гг

3. Дд.мм(бот берёт текущий год, если эта дата уже прошла, иначе предыдущий)

4. Дд(берётся текущие месяц и год, если дата уже прошла, иначе предыдущий месяц)

5. Дд<месяц>(аналогично формату «дд.мм»)

6. <день недели>(аналогично формату «дд»)

7. Сегодня

8. Вчера

*При этом дата не должна быть раньше 01.01.2000 и позже текущего дня.

Предметы*

1. Алгебра:

a. Алгебра

b. Алг

c. Математика

2. Биология:

a. Биология

b. Био

3. География:

a. География

b. Геогр

4. Геометрия:

a. Геометрия

b. Геом

5. Иностранный язык (английский):

a. Иностранный

b. Английский

c. Англ

d. Инглиш

6. Информатика:

a. Информатика

b. Инфа

7. История России. Всеобщая история:

a. История

b. Ист

c. Хистори

8. Литература:

a. Литература

b. Литер

c. Литра

d. Литрече

9. Обществознание:

a. Обществознание

b. Общество

c. Общес

d. Общага

e. Обществоведение

10. Основы безопасности жизнедеятельности:

a. Безопасность

b. ОБЖ

11. Русский язык:

a. Русский

b. Руссич

c. Русск

12. Технология:

a. Технология

b. Техн

c. Черчение

d. Черч

13. Физика:

a. Физика

14. Физическая культура:

a. Физическая

b. Физ-ра

c. Физра

d. Физра

15. Химия:

a. Химия

b. Химика

c. Хим

*Обращаем Ваше внимание, что список предметов предоставляется сайтом «Петербургское образование».

Документация к боту ВКонтакте

Homework - helperBot

 

Оглавление

О Homework-helperBot 3

Получение информации от бота. 4

Основная структура сообщения. 4

Получение информации о погоде. 6

Получение «биржевой сводки». 8

Публикация материалов с помощью бота. 9

Публикация. 9

Разрешение доступа к материалу. 10

Запрет доступа к материалу. 11

Удаление. 12

«Список доверия». 13

Общая информация. 13

ID пользователей. 14

Работа со «списком доверия». 15

Бонусы от бота. 16

«Быстрая» клавиатура. 17

Список допустимых вариаций. 18

Задания. 18

Дата*. 19

Предметы*. 20

 

ОHomework-helperBot

Данный бот предназначен для того, чтобы обеспечить постоянную коммуникацию учащихсяпо вопросам, касающимся учёбы. С помощью него можно публиковать и читать материалы одноклассников, а также получать официальное домашнее задание, заполненное учителем. В функционал бота также включены несколько бытовых команд для удобства пользователя.

Приятного пользования и

хорошей учёбы!

              Получение информации от бота