Бот как написать: 404 Page not found | База знаний Selectel

Как написать простого бота для ВК и Телеграм / Хабр

Мы уже упоминали, как мы предоставляем бесплатные VPS для студентов, чтобы они учились программировать. Один из наших подопечных Павел сделал простеньких телеграм и ВК ботов для FAQ. Они очень простые, тем не менее, начинающему программисту не помешают комментарии опытных ребят — поэтому публикуем его рассказ — Павел будет рад, если в комментариях ему дадут советы.

Я — студент Новосибирского Государственного Технического Университета, не так давно мы с парочкой моих друзей реализовали площадку для продвижения проектов во всех возможных областях научной деятельности. Мы помогаем «сводить» заинтересованных преподавателей и студентов всех ВУЗов Сибири, чтобы проектная научная деятельность развивалась по территории Сибири и РФ.

Студенты и преподаватели часто обращались ко мне с вопросами и я решил автоматизировать этот процесс, написав ботов для ВК и Телеграм.

На вход они принимают сообщения, а на выходе выдают либо текстовый ответ, либо специальную структуру данных, замаскированное под сообщение: инлайновые или висячие клавиатуры.

Я использовал Python версии 3.6  просто потому, что он самый простой для меня. Кодил в PyCharm Community Edition. Весь код опубликован на GitHub. Удачи!

1. Предварительные приготовления для телеграм-бота

1.1 Получение токена от BotFather в телеграмме

Первым делом, нам нужно «зарегистрировать» нашего бота в Telegram.

Для этого, в поисковике телеги ищем BotFather

далее, делаем всё также, как на скриншотах:

После нажимаем на команду /newbot или же прописываем вручную.

Надо придумать уникальное имя для бота, придумываем и получаем соответствующий токен.

1.2 Переходим в любой редактор кода и создаем файл config.py

Перед созданием данного файла, нам нужно выбрать директорию, в которой будет реализован весь функционал бота. Если вы используете PyCharm Community/Professional Edition, то предлагаю просто создать новый проект, и писать там весь функционал бота.

Если Вы используете любой другой редактор, такой как Sublime Text 3, например, то Вам самостоятельно придётся создать директорию, создать виртуальное окружение, и работать из консоли со всеми предварительными тестами. Во избежание трудностей, предлагаю скачать продукт PyCharm Community Edition от компании JetBrains, с помощью данного продукта можно обойти действия, описанные в предыдущем абзаце, так как данный продукт сделает их самостоятельно, от Вас потребуется только указать путь до интерпретатора Python в конфигурациях PyCharm, с помощью которого и будет работать Ваш бот.

В данном файле (config.py) будет храниться только токен, который нам дал BotFather, поэтому пишем:

token = "Здесь хранится Ваш токен".

1.3 Cоздаём главный файл — bot.py

Делаем cледующие импорты и для соответствующих библиотек, в консоли прописываем закоментированные строчки:

import config
import telebot # pip install telebot
from telebot import types # pip install pyTelegramBotAPI

Далее, нам необходимо использовать наш токен:

bot = telebot.TeleBot(config.token)
 

Этими действиям мы устанавливаем то, что мы будем накручивать функционал именно для того бота, для которого нам и дал токен BotFather.

2. Разворачиваем функционал

Начнём с того, что для того, чтобы пользователю запустить бота, нам необходимо прописать команды для старта они могут быть разными, например,

или

и вообще любыми, какие Вы сочтёте нужными.

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

Каждая функция, как и в примере сейчас, должна принимать один параметр — сообщение от пользователя, которое будет обработано соответствующей функции «в обёртке» декоратора. А также, каждая функция (или связка функций) должна возвращать соответсвующее сообщение от бота.

Итак:

@bot.message_handler(commands=['go', 'start'])  # Обработка команды для старта
def welcome(message):
    sti = open(path+'stiker.tgs', 'rb')
    bot.send_sticker(message.chat.id, sti)
    markup = types.ReplyKeyboardMarkup(resize_keyboard=True)

    item3 = types.KeyboardButton("Приложения")
    item2 = types.KeyboardButton("Мероприятия")
    item1 = types.KeyboardButton('О нас')

    markup.add(item1, item2, item3)

    bot.send_message(message.chat.id,
                     "Добро пожаловать, {0.first_name}!\\n\\nЯ - <b>{1.first_name}</b>, бот команды Projector в НГТУ, "
                     "создан для того, "
                     "чтобы помочь Вам влиться в нашу команду,"
                     "просто узнать что-то о нас или же просто пообщаться и весело провести время.\\n\\n"
                     "<i>Have a nice time</i>".format(
                         message.from_user, bot.get_me()),
                     parse_mode='html', reply_markup=markup)
 

В этой функции реализовано сразу два действия: отправка приветственного сообщения и создание встроенной клавиатуры —

, которая будет открыта, пока мы не завершим выполнения бота соответсвующей командой. Об этом будет сказано ниже.

Итак, пройдёмся по строчкам:

В строках 20-21: открывается стикер по тому пути к директории, в которой я его сохранил, после чего отправляется.

Строки 22-28: создаем встроенную клавиатуру, добавляя туда три элемента.

Строки 30-37: описано создание и отправка приветственного сообщения

Как вы можете заметить, метод send_message в строке 30, позволяет использовать HTML, для форматирования текста.

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

 # RUN
if __name__ == "__main__":
    try:
        bot.polling(none_stop=True)
    except ConnectionError as e:
        print('Ошибка соединения: ', e)
    except Exception as r:
        print("Непридвиденная ошибка: ", r)
    finally:
        print("Здесь всё закончилось")

Сделаем первый запуск! Для этого, в PyCharm-е нажмём зеленую кнопку старт в правом верхнем углу или же, можно запустить из консоли командой: python

Результат первого запуска:

2.1 Обработка нажатия на кнопки и создание inline keyboard

Так как любое сообщение — это текст, то мы будем обрабатывать именно текстовые сообщения.

Сделаем следующее и аналогично разберём по строчкам:

@bot.message_handler(content_types=["text"])
def go_send_messages(message):
    if message.chat.type == 'private':
        if message.text == 'Приложения':

            keyboard = types.InlineKeyboardMarkup(row_width=1)
            itemboo = types.InlineKeyboardButton(text="Тыщ на кнопку и ты уже в Google", url="<https://www.google.ru>")
            itemboo1 = types.InlineKeyboardButton('Рандомное число', callback_data='good2')
            itemboo2 = types.InlineKeyboardButton("Калькулятор", callback_data='bad2')
            itemboo3 = types.InlineKeyboardButton("Хочу узнать погоду в моем городе/стране", callback_data='good3')
            itemboo4 = types.InlineKeyboardButton("Как твои дела?", callback_data='bad4')

            keyboard.add(itemboo, itemboo1, itemboo2, itemboo3, itemboo4)

            bot.send_message(message.chat.id,
                             "{0.first_name}, окей, смотри, что у нас есть тут:\\n".format(message.from_user),
                             reply_markup=keyboard)

        elif message.text == "Мероприятия":
            one_markup = types.InlineKeyboardMarkup(row_width=1)
            ite1 = types.InlineKeyboardButton("Ближайшие мероприятия", callback_data="one")
            ite2 = types.InlineKeyboardButton("Проведенные мероприятия", callback_data="two")
            ite3 = types.InlineKeyboardButton("Волонтерство на мероприятие", callback_data="three")
            ite4 = types.InlineKeyboardButton("Действующие проекты в НГТУ", callback_data="fourth")
            ite5 = types.InlineKeyboardButton("Мероприятия Межвузовского центра", callback_data="five")
            one_markup.add(ite1, ite2, ite3, ite4, ite5)
            bot.send_message(message.chat.id, "{0.first_name}, у нас <u>ежемесячно</u> проводится множество "
                                              "мероприятий,\\nмы постарались разбить их на следующие составляющие:".format(
                message.from_user), parse_mode="html", reply_markup=one_markup)
 
 
 

Строка 339 — обработчик любых текстовых сообщений

Строка 341 предназначена для того, чтобы сказать, что если данное сообщение предназначено боту, то сравни эту строку с теми, что здесь обрабатываются и отправь ответ.

Строки 344 — 351 — создаём инлайновую клавиатуру InlineKeyboardMarkup и помещаем в эту клавиатуру 5 элементов, которые также можно будет обработать по установленной

Строки 353-355 — отправляют текст, вместе с нашей Inline Keyboard.

В условиях ниже представлены аналогичные представления обработки сообщений.

Итак, сделаем запуск:

2.2 Обработка InlineKeyboardButton

Как было сказано выше, каждый элемент

имеет параметр

, и именно по этим параметрам будет обрабатываться каждая кнопка. Для этого нам потребуется обработчик инлайновой клавиатуры

.

@bot.callback_query_handler(func=lambda call: call.data in ['one', 'two', 'three', 'fourth', 'five'])  # Мероприятия
def callback_inline_one(call):
    try:
        if call.message:
            if call.data == 'one':  # Ближайшие мероприятия
                bot.send_message(call.message.chat.id,
                                 "Итак,<b>ближайшие мероприятия</b>:\\n\\n"  # Здесь будут ссылки ещё
                                 "Форум «Байкал»\\n"
                                 "Конкурс «Цифровой ветер»\\n"
                                 "PRONETI", parse_mode="html")
            elif call.data == 'two':  # Проведённые мероприятия
                bot.send_message(call.message.chat.id, "Вот список <b>проведённых мероприятий</b>:\\n\\n"
                                                       "МНТК\\n"
                                                       "Семинары по проектной деятельности\\n"
                                                       "Встреча с представителями предприятий", parse_mode="html")
            elif call.data == 'three':
 

Итак, разберём построчно:

Строка 269 — объявляем обработчик, который будет обрабатывать каждую из нажатых кнопок с использованием лямбда-функции

Строки 273-278 — В данном блоке if, мы просто обрабатываем сообщение и отправляем сообщение пользователю.

Строки 279-283 — Делают аналогичное действие, что и в предыдущем условном блоке.

и т. д.

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

Результат:

Так просто и обрабатываются inline keyboards.

3. Завершаем работу бота

Данная функция будет аналогичной функции обработки команд для старта бота, поэтому Вы сможете легко понять её функционал:

@bot.message_handler(commands=['stop'])  # Обработка команды для выхода
def bye(message):
    bye_Sti = open(path+'byeMorty.tgs', 'rb')

    hideBoard = types.ReplyKeyboardRemove()
    bot.send_message(message.chat.id,
                     "Досвидания, {0.first_name}!\\nМы, команда <b>{1.first_name}</b>, надеемся, что ты хорошо провел(а) время \\n\\n"
                     "Присоединяйся к нашей команде в <a href='<https://vk.com/projector_neti>'>vk</a>\\n"
                     "Наш <a href='<https://instagram.com/projector_neti>'>inst</a>\\n\\n"
                     "Напиши Координатору проектов (<a href='<https://vk.com/nikyats>'>Никите Яцию</a>) и задай интересующие тебя вопросы по <i>проектной деятельности</i>\\n\\n"
                     "Надеемся, что тебе ответят очень скоро \\n\\n"
                     "<u>Don't be ill and have a nice day</u> \\n\\n\\n"
                     "P.S.: Если есть какие-то пожелания или вопросы по боту, то напиши <a href='<https://vk.com/setmyaddresspls>'>мне</a>".format(
                         message.from_user, bot.get_me()), parse_mode='html', reply_markup=hideBoard)
    exit()

Здесь происходит следующее:

1. Отправляется прощальный стикер.
2. Закрывается встроенная клавиатура (строка 44).
3. Отправляется прощальное сообщение.

Так как мы используем

, с параметром

, то пользователь может снова вознообновить общение с ботом при помощи команды

или

, обработка которых показано в пункте выше.

Результат:

ВК БОТ

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

1. Предварительные подготовления

Установим следующие библиотеки по тем же технологиям:

import vk_api # pip install vk-api
import json   # pip install json
from vk_api.longpoll import VkLongPoll, VkEventType

▍1.1 Получение токена для сообщества Вконтакте.

1. На главной странице сообщества найти раздел «Управление»
2. Работа с API
3. Создать ключ. Выбираете нужные для вас пункты, которые будут доступны боту.

В итоге должно получиться примерно следующее:

Берем ключ и переходим в среду разработки и делаем следующее:

vk = vk_api.VkApi(token=
                  "Ваш_токен")

Далее — следующее:

longpoll = VkLongPoll(vk)

На этом, закончим подготавления.

2. Разворачиваем функционал

Первым делом создадим файл

Cоздадим прототип встроенной клавиатуры ( всё с помощью документации VkBotAPI ).

main_keyboard = {
    "one_time": False,
    "buttons": [
        [{
            "action": {
                "type": "text",
                "payload": "{\\"button\\": \\"1\\"}",
                "label": "О нас"
            },
            "color": "positive"
        }],
        [{
            "action": {
                "type": "text",
                "payload": "{\\"button\\": \\"2\\"}",
                "label": "Мероприятия"
            },
            "color": "positive"
        },
            {
                "action": {
                    "type": "text",
                    "payload": "{\\"button\\": \\"3\\"}",
                    "label": "Приложения"
                },
                "color": "positive"
            }
        ],
        [{
            "action": {
                "type": "text",
                "payload": "{\\"button\\": \\"4\\"}",
                "label": "Контакты"
            },
            "color": "primary"
        }]
    ]
}

Затем переводим её в формат json, как требуется в документации:

main_keyboard = json.dumps(main_keyboard, ensure_ascii=False).encode('utf-8')
main_keyboard = str(main_keyboard.decode('utf-8'))

Пример инлайн клавиатуры:

about_us_keyboard = {
    "inline": True,
    "buttons": [
        [{
            "action": {
                "type": "text",
                "payload": "{\\"button\\": \\"1\\"}",
                "label": "Основная информация"
            },
            "color": "positive"
        }],
        [{
            "action": {
                "type": "text",
                "payload": "{\\"button\\": \\"2\\"}",
                "label": "Чем мы занимаемся ?"
            },
            "color": "primary"
        },
        {
            "action": {
                "type": "text",
                "payload": "{\\"button\\": \\"3\\"}",
                "label": "Где мы находимся ?",
            },
            "color": "positive"
        }],
        [{
            "action": {
                "type": "text",
                "payload": "{\\"button\\": \\"4\\"}",
                "label": "Как попасть в команду ?",
            },
            "color": "primary"
        }],
        [{
            "action": {
                "type": "text",
                "payload": "{\\"button\\": \\"5\\"}",
                "label": "Контакты",
            },
            "color": "secondary"
        }],
        [{
            "action": {
                "type": "text",
                "payload": "{\\"button\\": \\"6\\"}",
                "label": "Задать вопрос руководителю проекта",
            },
            "color": "negative"
        }]
    ],
}

Не забываем все используемые клавиатуры переводить в формат json:

about_us_keyboard = json.dumps(about_us_keyboard, ensure_ascii=False).encode('utf-8')
about_us_keyboard = str(about_us_keyboard.decode('utf-8'))

Создадим функцию

, для того, чтобы не мучиться с постоянной отправкой сообщений от бота:

def write_msg(user_id, message, key):
    vk.method('messages.send',
              {'user_id': user_id,
               'message': message,
               'keyboard': key,
               'random_id': random.randint(0, 2048)})

После создания всех прототипов, мы можем перейти к следующему шагу. ( к этому файлу мы позже вернёмся и доработаем обработку общения пользователя и нашего vk-бота )

▍2.1 Основной функционал (создаем файл vk_bot.py)

Мы не будем разрабатывать методы, которые будут выполнять, например, функцию парсинга времени или погоды, назовем их второстепенными. Я покажу лишь основной метод, который будет обращаться к этим второстепенным методам, для обработки тех или иных сообщений от пользователя. В конце статьи я выложу ссылку на свой GitHub, где Вы сможете самостоятельно просмотреть интересующий Вас функционал любого из метода. Итак:

Конструктор класса:

class VkBot:

    def __init__(self, user_id):
        self.USER_ID = user_id
        self._USERNAME = self._get_user_name_from_vk_id(user_id)
        self.my_str = ""
        self._COMMANDS = ["привет", "погода", "время", "пока"]

        self._inputMes = {"основная информация": answers.about_us1,
                          "чем мы занимаемся ?": answers.about_us2,
                          "где мы находимся ?": answers.about_us3,
                          "ближайшие мероприятия": answers.events1,
                          "проведённые мероприятия": answers.events2,
                          "волонтёрство на мероприятие": answers.events3,
                          "действующие проекты в нгту": answers.events4,
                          "мероприятия межвузовского центра": answers.events5
                          }

Последнее свойство класса —

— это особый словарь, у которого значения ключей — это текст из файла

, где я расположил текст в виде строк, поэтому, чтобы не загромождать код я и вынес основной текст в другой файл.

(Пример кода из файла answers.py)

events1 = "Итак,ближайшие мероприятия:\\n\\n" \\
          "Форум «Байкал»\\n"\\
          "Конкурс «Цифровой ветер»\\n"\\
          "PRONETI"

events2 = "Вот список проведенных мероприятий:\\n"\\
        "МНТК\\n"\\
        "Семинары по проектной деятельности\\n"\\
        "Встреча с представителями предприятий\\n"\\

events3 = "По поводу этого критерия напиши Илье (<https://vk.com/ki1337ki>)\\n"\\
        "А также, ты можешь заполнить анкету, благодаря которой,\\n"\\
        "с тобой лично свяжется один из руководителей направления\\n"\\
        "или координатор проекта (<https://vk.com/nikyats>)"

Итак, основной метод класса — это

, который принимает один параметр —

, который обрабатывается соответствующим условным блоком и возвращает какое -то значение обратно туда, откуда был вызван.

def _get_user_name_from_vk_id(self, user_id):
    request = requests.get("<https://vk.com/id>" + str(user_id))

    bs = bs4.BeautifulSoup(request.text, "html.parser")

    user_name = self._clean_all_tag_from_str(bs.findAll("title")[0])

    return user_name.split()[0]

def new_message(self, message):
    # self.my_str = " ".join(re.findall('[0-9]{2}', message))

    if message.lower() == self._COMMANDS[0]:
        return f"Привет, {self._USERNAME}!"

    elif message.lower() == self._COMMANDS[1] or message.lower() == "узнать погоду ":
        return self._get_weather()

    elif message.lower() == self._COMMANDS[2] or message.lower() == "узнать точное время ":
        return self._get_time()

    elif message.lower() == self._COMMANDS[3]:
        return f"До скорой встречи, {self._USERNAME}!"

    else:
        for key, value in self._inputMes.items():
            if message.lower() == key:
                return value
        return "Не понимаю тебя "

3. Возвращаемся в manage.py и дописываем функционал

Теперь в первых строках нам необходимо проимпортить файл vk_bot. А также нам потребуется библиотека random.

import random # pip install random
from vk_bot import VkBot

После того, как мы объявили longpoll, дописываем основной функционал.

longpoll = VkLongPoll(vk)

try:
    for event in longpoll.listen():
        if event.type == VkEventType.MESSAGE_NEW:
            if event.to_me:
                bot = VkBot(event.user_id)

                if event.text.lower() == "о нас":
                    write_msg(event.user_id, "Немного о нашем проекте", about_us_keyboard)
                elif event.text.lower() == "мероприятия":
                    write_msg(event.user_id, "Что ты хочешь узнать?", events_keyboard)
                elif event.text.lower() == "приложения":
                    write_msg(event.user_id, "Посмотри, что есть здесь!", app_keyboard)
                elif event.text.lower() == "контакты":
                    write_msg(event.user_id, "По любым вопросам можешь обращаться к:", contacts_keyboard)
                elif event.text.lower() == "задать вопрос руководителю проекта":
                    write_msg(event.user_id, "У тебя есть возможность написать сообщение нашему Руководителю проекта",
                              go_answer)
                elif event.text.lower() == "калькулятор":
                    write_msg(event.user_id, "В разработке...", calc_keyboard)
                # elif event.text == " ".join(re.findall('\\d{2}', event.text)):
                #     write_msg(event.user_id, "Отлично, мы здесь", calc_keyboard)
                elif event.text.lower() == "как попасть в команду ?":
                    write_msg(event.user_id, "Напиши координатору проекта - Никите\\n"
                                             "или перейди на сайт проектной деятельности,\\n"
                                             "найди проект номер 612 и подай заявку", in_team)
                else:
                    write_msg(event.user_id, bot.new_message(event.text), main_keyboard)

except Exception as e:
    print(e)

Как можете заметить, в условных блоках if и elif — присутствует обработка тех сообщений, которые подразумевают под собой вывод инлайн или встроенной клавиатуры (в данном примере — выводятся только инлайн клавиатуры). Сюда также можно добавить более сложные обработки сообщений, после которых обработка будет метаться туда сюда по блокам if и elif. Таким образом бот будет работать, пока не «упадёт с ошибкой».

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

Заключение

Надеюсь, что после прочтения данной статьи, Вы как минимум поняли основной принцип создания своего Telegram или Vk бота, а как максимум — легко сможете написать своего бота.

Как вы можете видеть, создать его функционал очень просто, особенно, если вы знаете основы языка Python.

Весь код опубликован в моём профиле GitHub:

этапы написания, исследования, рабочие схемы, структура, тексты и рекомендации

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

Предварительная работа

Узнайте свою аудиторию

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

Персона покупателя — смоделированный профиль вашего типичного клиента, созданный со слов реальных покупателей. 

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

Читайте также:

Что такое CJM? Разбираем основные элементы карты клиентского пути

Поставьте цель и задачи

Ответьте себе на вопрос: «для чего нам нужен чат-бот?». Ответом на этот вопрос и станет цель работы онлайн-консультанта. Ниже несколько типичных целей для бота:

• Сбор лидов — бот может собирать данные клиентов для отдела продаж;
• Оформление заказов — особенно актуально для ресторанов или доставки пиццы, где точно известен конечный результат и немного шагов до конверсионного действия;
• Сбор обратной связи — бот соберет отзывы от клиентов в автоматическом режиме;
• Консультация пользователя по выбору товара/услуги — бот расскажет посетителям об основных характеристиках товаров и услуг, ответ на часто задаваемые вопросы и подберёт лучшее предложение;
• Техническая поддержка пользователя — бот поможет решить типичные проблемы клиентов;
• Повысить эффективность работы менеджеров — бот узнает основную информацию о пользователе и его потребности, чем ускорит и упростит работу сотрудника отдела продаж.

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

Определите структуру чат-бота

Структура чат-бота определяет его вариативность и длину. Некоторые выявляют, на каком этапе воронки продаж находится пользователь, другие больше направлены на консультацию и продажу. Ниже несколько вариантов структуры чат-ботов.

Пирамида 

Перчатка

Карта

Квест

Сценарий и тексты для чат-бота

Создание сценария к чат-боту происходит в 3 этапа: цели, схема, контент. Некоторые редактируют готовые сценарии чат-бота под свои цели, но мы рекомендуем их использовать максимум как пример для разработки собственного сценария.

Как можно догадаться, первый этап вы выполните еще на моменте предварительного исследования. Вы должны понимать, какую цель достигает клиент с помощью бота. Это фундамент для разработки схемы диалога.

Второй этап — разработка визуальной схемы вопросов и ответов чат-бота. Закройтесь в переговорке, взяв с собой весь набор стандартных вопросов и ответов, и начните выстраивать логику и цепочки чат-бота. Сейчас вы определяете, какой вопрос ведет к какой ветке, и объединяете это в единую систему.

Читайте также:

5 проблем онлайн-консультанта и можно ли их решить

• Соответствуйте Tone of voice. Тексты в боте должны быть аналогичны общему стилю общения компании с клиентами. Вы местный автосервис? Тогда нет смысла «выкать» и играть во франта в чате, говорите с аудиторией на одном языке на всех площадках. 
• В чатах принято писать емко и коротко. Ограничьте ответы бота 60-150 знаками максимум. Разбивайте большие предложения на два коротких. Используйте тот же принцип, что и в переписке в мессенджерах. 
• Разбивайте любые инструкции на шаги и отдельные сообщения. 1 мысль — 1 сообщение. Это удобно для восприятия.     
• Не бойтесь эмодзи. Для мессенджеров и чатов это органично. К тому же, вы добавляете еще один эмоциональный слой и упрощаете усвоение информации. 😎
• Пишите естественно. Даже если у вас тысячи клиентов, общаться с человеком бот будет персонально. Поэтому не душите его канцеляризмами и титулами. Приветливо предложенная помощь куда нужнее обещания премиум-сервиса и широкого ассортимента. 

Вёрстка и тест чат-бота

1. Добавьте новую или вставьте скопированную реакцию. Новые реакции появятся ниже отдельными кнопками. 
2. Вы можете копировать как отдельные шаги, так и целые ветки в чат-боте. Удобно, если у вас много повторяющихся элементов. Скопированное можно вставить в любое место в существующем боте, либо другой проект. 
3. На каждом этапе вы можете предложить пользователю оставить контакты или позвать оператора.
4. Реакции пользователей можно менять местами. Каждая реакция ведет к новой ветке диалога и запускает отдельный сценарий.
5. Для дополнительных настроек чат-бота перейдите в отдельную вкладку. Там вы можете установить время работы чат-бота, его имя, каналы работы, аватарку и прочее. Подробнее о настройках есть заметка в Помощи. 

7 рекомендаций по написанию чат бота

Репетируйте. Выявить неестественность и слабые этапы в сценарии поможет обыкновенная читка текстов вслух. Пройдитесь по сценарию вместе с сотрудниками и отправляйте на доработку те ветки, которые ослабляют погружение клиента и не несут явной пользы. 

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

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

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

Не выдавайте бота за человека. Любой обман отталкивает клиента от вас. И если вы постараетесь выдать чат-бота за настоящего оператора, то вас быстро раскусят и оставят без конверсионного действия. Поэтому рекомендуем уже в приветствии сообщить клиенту, что он пишет роботу. 

Выстройте тайминги появления ответа. Не сбивайте темп переписки в чате, показывайте ответ на вопрос человеку спустя 1-3 секунды, чтобы создать иллюзию живого общения. 

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

Заключение 

Как оказалось, создать чат-бот не так уж сложно. Достаточно пары базовых маркетинговых исследований и рабочего визуального конструктора. Однако создав сценарий и запустив робота, вы не закрыли задачу. Поведение пользователей постоянно меняется, поэтому совершенствование бота станет регулярным делом. Цепочки, которые работали вчера, не работают сегодня и так далее. 

Регулярно тестируйте эффективность диалогов, расширяйте возможности чат-бота и займитесь аналитикой. В итоге вы получите современный инструмент автоматизации, чья польза для клиента и бренда будет безусловной. 

Telegram-бот на Python: пошаговое руководство

Делимся инструкцией, как написать бота с помощью библиотеки python-telegram-bot за считанные минуты. На примере гайда от программиста Давида Мастроматтео.

Установка python-telegram-bot

Для создания бота понадобится пакет python-telegram-bot — оболочка для API от Telegram. Написать бота с помощью этой библиотеки очень просто, так как она полностью совместима с Python 3.6+.

Первое, что нужно сделать — установить python-telegram-bot. Вот ссылка на официальную документацию библиотеки. 

$ pip install python-telegram-bot –upgrade

Создание бота

Теперь можно взяться за создание бота. Для этого даже не нужно писать код. Перейдите в Telegram и найдите канал @BotFather, который отвечает за регистрацию новых ботов. Начните общаться с ботом и введите команду /newbot. Затем BotFather спросит у вас имя и юзернейм.

BotFather 1

BotFather 2

У BotFather можно запросить много других интересных вещей. Например, изменить изображение профиля бота.

Теперь нужно принять важное решение: определиться с главной задачей бота. В этой инструкции мы сделаем бота, который предоставляет информацию о биоритмах пользователей. Будьте осторожны: речь идет о псевдонаучных теориях, так что бот будет такой же полезный, как и гороскопы. Но если дойдете до конца — сможете создавать любых ботов.

Программирование бота 

Пакет python-telegram-bot состоит из оболочки API Telegram. Этот инструмент доступен через telegram.Bot-классы. Помимо них, есть еще модуль telegram.ext, который значительно упростит работу.

Модуль telegram.ext содержит много классов, но самые важные — telegram.ext.Updater и telegram.ext.Dispatcher. Updater отвечает за выборку новых обновлений от Telegram. Также он передает их в Dispatcher, после чего они обрабатываются с помощью Handler.

Приступим к программированию:

# mastrobot_example.py
from telegram.ext import Updater, CommandHandler, MessageHandler, Filters

# function to handle the /start command
def start(update, context):
    update.message.reply_text('start command received')

# function to handle the /help command
def help(update, context):
    update.message.reply_text('help command received')

# function to handle errors occured in the dispatcher 
def error(update, context):
    update.message.reply_text('an error occured')

# function to handle normal text 
def text(update, context):
    text_received = update.message.text
    update.message.reply_text(f'did you said "{text_received}" ?')

def main():
    TOKEN = "insert here your token and don't share it with anyone!"

    # create the updater, that will automatically create also a dispatcher and a queue to 
    # make them dialoge
    updater = Updater(TOKEN, use_context=True)
    dispatcher = updater.dispatcher

    # add handlers for start and help commands
    dispatcher.add_handler(CommandHandler("start", start))
    dispatcher.add_handler(CommandHandler("help", help))

    # add an handler for normal text (not commands)
    dispatcher.add_handler(MessageHandler(Filters.text, text))

    # add an handler for errors
    dispatcher.add_error_handler(error)

    # start your shiny new bot
    updater.start_polling()

    # run the bot until Ctrl-C
    updater.idle()

if __name__ == '__main__':
    main()

В функции main создан класс Updater, который автоматически сгенерировал объект Dispatcher, доступный через .dispatcher-свойства класса Updater.

Добавьте несколько обработчиков:

• команда /start вызывает функцию start(), которая отвечает пользователю информативным сообщением;
• команда /help вызывает функцию help(), которая отвечает пользователю информативным сообщением;
• если при отправке сообщений возникает ошибка, вызываем функцию error();
• если пользователь напишет фразы или символы, которые не являются командой, вызываем функцию text(), отвечающую пользователю тем же полученным текстом.

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

Тестирование

Теперь можно протестировать бота. Запустите его.

$ python mastrobot_example.py

Пошлите ему команду /start .

Ура, бот работает!

Но это не конец. Надо создать бота, который сообщает пользователю его ежедневный биоритм. Для этого следует применить команду /start. С ее помощью при запуске чата можно получить данные о дне рождения пользователя. Затем надо создать функцию для обработки новой команды /biorhythm, чтобы отправить ответ пользователю с его личным биоритмом.

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

# function to handle the /start command
def start(update, context):
    first_name = update.message.chat.first_name
    update.message.reply_text(f"Hi {first_name}, nice to meet you!")
    start_getting_birthday_info(update, context)

В параметре update можно найти полезную информацию о пользователе, например, его имя.

В самом начале скрипта определите новую переменную STATE, которая нужна, чтобы понять, на какой вопрос отвечает пользователь.

STATE = None

BIRTH_YEAR = 1
BIRTH_MONTH = 2
BIRTH_DAY = 3

Теперь необходимо реализовать функцию start_getting:_birthday_info(), она вызывается с помощью команды start(). После запуска вы получите информацию о дне рождения от пользователя.

def start_getting_birthday_info(update, context):
    global STATE
    STATE = BIRTH_YEAR
    update.message.reply_text(f"I would need to know your birthday, so tell me what year did you born in...")

Для переменной STATE устанавливается значение BIRTH_YEAR, чтобы после ответа пользователя было понятно, что вопрос касался года рождения. Затем отправляется сообщение, чтобы узнать год рождения.

Теперь пользователь ответит обычным текстом, поэтому нужно изменить функцию text().

def text(update, context):
    global STATE

    if STATE == BIRTH_YEAR:
        return received_birth_year(update, context)

    if STATE == BIRTH_MONTH:
        return received_birth_month(update, context)

    if STATE == BIRTH_DAY:
        return received_birth_day(update, context)

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

Эти функции можно записать так:

def received_birth_year(update, context):
    global STATE

    try:
        today = datetime.date.today()
        year = int(update.message.text)
        
        if year > today.year:
            raise ValueError("invalid value")

        context.user_data['birth_year'] = year
        update.message.reply_text(f"ok, now I need to know the month (in numerical form)...")
        STATE = BIRTH_MONTH
    except:
        update.message.reply_text("it's funny but it doesn't seem to be correct...")

def received_birth_month(update, context):
    global STATE

    try:
        today = datetime.date.today()
        month = int(update.message.text)

        if month > 12 or month < 1:
            raise ValueError("invalid value")

        context.user_data['birth_month'] = month
        update.message.reply_text(f"great! And now, the day...")
        STATE = BIRTH_DAY
    except:
        update.message.reply_text("it's funny but it doesn't seem to be correct...")

def received_birth_day(update, context):
    global STATE

    try:
        today = datetime.date.today()
        dd = int(update.message.text)
        yyyy = context.user_data['birth_year']
        mm = context.user_data['birth_month']
        birthday = datetime.date(year=yyyy, month=mm, day=dd)

        if today - birthday < datetime.timedelta(days=0):
            raise ValueError("invalid value")

        context.user_data['birthday'] = birthday
        STATE = None
        update.message.reply_text(f'ok, you born on {birthday}')

    except:
        update.message.reply_text("it's funny but it doesn't seem to be correct...")

Когда получен год рождения пользователя, остается проверить, допустимое ли это значение. Если да, то оно сохраняется в словаре context.user_data[]. Продолжайте устанавливать значения для переменной STATE и задавать следующие вопросы.

Когда зададите последний вопрос и будете знать день рождения, создайте переменную даты и сохраните ее в context.user_data[] словаре.

Если пользователь вводит недопустимое значение, то получает ответ, что оно неверно. Значение переменной STATE не меняется, поэтому пользователь застревает на этом вопросе, пока не ответит правильно.

Создание команды

Теперь нужно обработать команду /biorhythm.

Добавьте новый обработчик команд в функцию main().

dispatcher.add_handler(CommandHandler("biorhythm", biorhythm))

Напишите функцию расчета биоритма:

# This function is called when the /biorhythm command is issued

def biorhythm(update, context):

    user_biorhythm = calculate_biorhythm(

        context.user_data['birthday'])

    update.message.reply_text(f"Phisical: {user_biorhythm['phisical']}")

    update.message.reply_text(f"Emotional: {user_biorhythm['emotional']}")

    update.message.reply_text(f"Intellectual: {user_biorhythm['intellectual']}")

def calculate_biorhythm(birthdate):

    today = datetime.date.today()

    delta = today - birthdate

    days = delta.days

    phisical = math.sin(2*math.pi*(days/23))

    emotional = math.sin(2*math.pi*(days/28))

    intellectual = math.sin(2*math.pi*(days/33))

    biorhythm = {}

    biorhythm['phisical'] = int(phisical * 10000)/100

    biorhythm['emotional'] = int(emotional * 10000)/100

    biorhythm['intellectual'] = int(intellectual * 10000)/100

    biorhythm['phisical_critical_day'] = (phisical == 0)

    biorhythm['emotional_critical_day'] = (emotional == 0)

    biorhythm['intellectual_critical_day'] = (intellectual == 0)

    return biorhythm

В примере представлены две разные функции: одна для обработки команды, а другая для расчета биоритма. Таким образом удается разделить ответственность этих функций.

Полный код бота

# mastrobot_example2.py
import datetime
import math
from telegram.ext import Updater, CommandHandler, MessageHandler, Filters

STATE = None
BIRTH_YEAR = 1
BIRTH_MONTH = 2
BIRTH_DAY = 3

# function to handle the /start command
def start(update, context):
    first_name = update.message.chat.first_name
    update.message.reply_text(f"Hi {first_name}, nice to meet you!")
    start_getting_birthday_info(update, context)

def start_getting_birthday_info(update, context):
    global STATE
    STATE = BIRTH_YEAR
    update.message.reply_text(
        f"I would need to know your birthday, so tell me what year did you born in...")

def received_birth_year(update, context):
    global STATE

    try:
        today = datetime.date.today()
        year = int(update.message.text)

        if year > today.year:
            raise ValueError("invalid value")

        context.user_data['birth_year'] = year
        update.message.reply_text(
            f"ok, now I need to know the month (in numerical form)...")
        STATE = BIRTH_MONTH
    except:
        update.message.reply_text(
            "it's funny but it doesn't seem to be correct...")

def received_birth_month(update, context):
    global STATE

    try:
        today = datetime.date.today()
        month = int(update.message.text)

        if month > 12 or month < 1:
            raise ValueError("invalid value")

        context.user_data['birth_month'] = month
        update.message.reply_text(f"great! And now, the day...")
        STATE = BIRTH_DAY
    except:
        update.message.reply_text(
            "it's funny but it doesn't seem to be correct...")

def received_birth_day(update, context):
    global STATE

    try:
        today = datetime.date.today()
        dd = int(update.message.text)
        yyyy = context.user_data['birth_year']
        mm = context.user_data['birth_month']
        birthday = datetime.date(year=yyyy, month=mm, day=dd)

        if today - birthday < datetime.timedelta(days=0):
            raise ValueError("invalid value")

        context.user_data['birthday'] = birthday
        STATE = None
        update.message.reply_text(f'ok, you born on {birthday}')

    except:
        update.message.reply_text(
            "it's funny but it doesn't seem to be correct...")

# function to handle the /help command
def help(update, context):
    update.message.reply_text('help command received')

# function to handle errors occured in the dispatcher
def error(update, context):
    update.message.reply_text('an error occured')

# function to handle normal text
def text(update, context):
    global STATE

    if STATE == BIRTH_YEAR:
        return received_birth_year(update, context)

    if STATE == BIRTH_MONTH:
        return received_birth_month(update, context)

    if STATE == BIRTH_DAY:
        return received_birth_day(update, context)

# This function is called when the /biorhythm command is issued
def biorhythm(update, context):
    print("ok")
    user_biorhythm = calculate_biorhythm(
        context.user_data['birthday'])

    update.message.reply_text(f"Phisical: {user_biorhythm['phisical']}")
    update.message.reply_text(f"Emotional: {user_biorhythm['emotional']}")
    update.message.reply_text(f"Intellectual: {user_biorhythm['intellectual']}")

def calculate_biorhythm(birthdate):
    today = datetime.date.today()
    delta = today - birthdate
    days = delta.days

    phisical = math.sin(2*math.pi*(days/23))
    emotional = math.sin(2*math.pi*(days/28))
    intellectual = math.sin(2*math.pi*(days/33))

    biorhythm = {}
    biorhythm['phisical'] = int(phisical * 10000)/100
    biorhythm['emotional'] = int(emotional * 10000)/100
    biorhythm['intellectual'] = int(intellectual * 10000)/100

    biorhythm['phisical_critical_day'] = (phisical == 0)
    biorhythm['emotional_critical_day'] = (emotional == 0)
    biorhythm['intellectual_critical_day'] = (intellectual == 0)

    return biorhythm

def main():
    TOKEN = "insert here your token and don't share it with anyone!"

    # create the updater, that will automatically create also a dispatcher and a queue to
    # make them dialoge
    updater = Updater(TOKEN, use_context=True)
    dispatcher = updater.dispatcher

    # add handlers for start and help commands
    dispatcher.add_handler(CommandHandler("start", start))
    dispatcher.add_handler(CommandHandler("help", help))
    # add an handler for our biorhythm command
    dispatcher.add_handler(CommandHandler("biorhythm", biorhythm))

    # add an handler for normal text (not commands)
    dispatcher.add_handler(MessageHandler(Filters.text, text))

    # add an handler for errors
    dispatcher.add_error_handler(error)

    # start your shiny new bot
    updater.start_polling()

    # run the bot until Ctrl-C
    updater.idle()


if __name__ == '__main__':
    main()

Пришло время проверить его:

Telegram bot

Поздравляем! Telegram-бот на Python полностью готов. 

Бот, созданный для примера, был сохранен. Его можно протестировать по имени пользователя @mastro35_mastrobot.

Создаем Telegram-бота и зарабатываем на нем. Инструкция

Создать и настроить бота довольно просто. Для этого совсем не обязательно владеть языками программирования. 

Для начала нужно придумать имя, продумать команды, найти два Telegram-бота в помощь — @Fatherbot и @Manybot. Приступаем.

Шаг 1. Находим в строке поиска мессенджера приложение @FatherBot.

@FatherBot — это главный бот, который помогает создавать и изменять существующие боты. 

Шаг 2. Заходим в беседу с ботом, читаем описание.

Для начала работы нам нужно отправить команду /start.

Эта команда выведет на экран главное меню (список всего того, что умеет @FatherBot).

Кстати, не обязательно печатать команды вручную, достаточно ввести символ «/» в диалоговом окне. После этого отобразится лист доступных команд, и вы сможете кликнуть на нужную. 

Также можно нажать на подсвеченную синим цветом  команду в выпавшем сообщении с меню.

Шаг 3. Создаем бот.

Чтобы приступить к созданию нового бота, отправляем команду /newbot.
Получаем ответное сообщение, где нужно ввести название бота.

Вводим имя нашего бота.

Шаг 4. Придумываем юзернейм. 

Теперь нам нужно придумать юзернейм, который позволит находить бот внутри мессенджера или через браузер.

Важно: название бота должно оканчиваться на слово «bot» (welcome_bot, information_bot, newsbot).

@FatherBot сообщает нам, что юзернейм свободен и теперь закреплен за нашим ботом.

Теперь у нашего бота есть собственная гиперссылка, через которую пользователи могут находить бот и заходить в чат через браузер и сам мессенджер (http://t.me/StarsFriens_bot).

Также мы получаем токен (API-ключ). Это набор символов, исходный код нашего бота, который позволяет управлять им и изменять его в специальных конструкторах. Токен понадобится на следующих этапах работы с ботом.

Шаг 5. Переходим к настройкам бота. 

Отправляем в чат @FatherBot команду /mybots и выбираем нужный бот для редактирования (сейчас у нас только один тестовый бот, но впоследствии можно создавать и редактировать неограниченное количество ботов).

Отправляем в чат @FatherBot команду /mybots и 

выбираем нужный бот для редактирования (сейчас у нас только один тестовый бот, но впоследствии можно создавать и редактировать неограниченное количество ботов).

Нажимаем на наш тестовый бот, получаем сообщение с меню, где нас спрашивают, что бы мы хотели сейчас сделать. Нажимаем в меню команду «Edit Bot» и получаем области редактирования нашего бота. 

На скриншоте видим «скелет» бота. Сейчас у него есть только название, но нет ни описания, ни каких-либо команд (действий, которые могут совершать с ним пользователи). По мере того как вы будете изменять бот, эти поля заполнятся.

Например, выбираем поле «Edit Description» и нажимаем соответствующую кнопку. 

Получаем сообщение, где нам предлагают дать описание того, чем наш бот поможет пользователям (такое же сообщение выпало нам, когда мы зашли в чат с @FatherBot).

Добавляем текст и получаем подтверждающее сообщение, что описание к боту добавлено.

Клавишу «Back to Bot» мы нажимаем каждый раз после того, как внесли изменение и хотим вернуться к другим настройкам бота.

Кстати, если нажмете клавишу «Back to Bot» и вернетесь к настройкам, то увидите, что «скелет» бота обновился: добавилось описание (Description).

В чем разница между полем Description и About? Description мы видим, когда уже зашли в чат с ботом. Поле About — это описание профиля бота, которое пользователи видят до начала диалога.

Снова нажимаем «Edit Bot», выбираем кнопку «Edit About». Поле About не должно превышать 120 символов.

About изменено. Нам снова предлагают либо вернуться к меню с настройками, либо к списку наших ботов (напоминаем, у нас он пока только один). 

Давайте посмотрим, где находится Description и About на примере нашего бота. Как это увидят пользователи? Мы уже можем ввести в поиске Telegram название нашего бота @StarsFriend_bot

В профиле бота видим поле About, а в самом чате — Description:

Шаг 5. Добавляем картинку.

Снова выбираем «Edit Bot», затем «Edit Botpic». Присылаем в чат заранее подготовленную картинку.

Нажимаем «Back to Bot», смотрим на «скелет» нашего бота.
Теперь здесь отображаются почти все параметры, кроме команд. Для настройки команд понадобится специальный редактор ботов — @Manybot.

Шаг 6. Добавляем команды через редактор @Manybot. 

Так как @Fatherbot не позволяет создавать команды для новых ботов, мы будем настраивать наш бот через специальные редакторы, например, через @Manybot.

@Manybot — многофункциональная платформа для создания и редактирования ботов, доступная на русском языке. В ней легко создавать меню и команды. Здесь же можно редактировать описание и другие параметры бота без знания языков программирования.

Находим бот в поиске приложения Telegram, отправляем в чат команду /start.

Получаем сообщение с меню.

На месте клавиатуры появляется меню, которым  мы будем пользоваться в дальнейшем. Нам нужно выбрать «Добавить бота».

Обратите внимание, что @Manybot содержит подробный список инструкций по любым настройкам. Нажмите на кнопку «Инструкции» (или отправьте в чат команду /tutorials) — и получите детальные гиды (на скриншоте отражена лишь часть инструкций). Нажмите кнопку «Помощь» — и снова получите меню доступных действий с вашим ботом (как на скриншоте выше):

Если вам недостаточно той информации, которая есть в меню самого @Manybot, вы можете найти большое количество пошаговых видео и инструкций в интернете. Так и гуглим: «Manybot инструкция».

Итак, нажимаем «Добавить нового бота». В ответ на команду @Manybot предлагает уже знакомый нам алгоритм. Остается только скопировать токен (напомним, мы получили его в самом начале от @FatherBot) и прислать его в сообщении @Manybot.

Важно! Никому не присылайте свой токен. Пользуйтесь только проверенными конструкторами ботов. Мы ведь не хотим, чтобы наш бот попал в чужие руки. 

Отправляем сообщение «Я скопировал токен».

Присылаем наш токен из сообщения в чате с @Fatherbot.

Токен принят, и сейчас мы перейдем в чат с нашим ботом и далее будем работать в нем.

В чате с @Manybot даем команду /newpost (или нажимаем клавишу меню «Отправить новое сообщение подписчикам»). Выбираем нашего бота в выпавшем сообщении.

Нажимаем на название бота в сообщении, и нас перебрасывает в чат с  нашим ботом. Здесь видим сообщение, которое только что отправил нам @Manybot. Оно содержит меню с настройками. Это пульт управления нашим ботом. Здесь можем перечитать подробные инструкции по каждому пункту. И снова видим удобные клавиши меню на месте клавиатуры:

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

Сначала настроим команды, а затем уже их вид в меню (то, как их будут видеть подписчики).

Выбираем «Создать команду». 

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

Так как тематика нашего тестового бота связана с астрономией и астрологией, в качестве одной из команд мы вставим ссылку на сайт NASA. Эту команду (опцию будущего меню) так и назовем: /site. 

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

Вы можете добавить для подписчиков возможность задавать боту вопросы. Для этого есть специальная кнопка «Добавить вопрос». Нажимаем ее и видим варианты: «Обычный вопрос», «Развернутый ответ», «С вариантами ответа». 

Вы также можете включить «Режим Случайного Сообщения».

Приведем пример еще двух команд: /wallpaper (мы хотим, чтобы пользователи могли скачать тематические обои) и /info (после этой команды пользователь получит информацию о создателях бота).

Для /wallpaper используем режим случайного сообщения и загрузим пять картинок. Нажимаем «Сохранить».

Шаг 7. Настройка меню бота.

Благодаря удобным клавишам меню снизу добавляете и упорядочиваете команды, которые вы задали боту на предыдущих этапах.

Выбираем «Настроить гл.меню», «Добавить пункт меню», выбираем уже созданную нами команду, называем ее (финальное название для пользователя, а не формат /команда), сохраняем.

Например, хотим переименовать команду /info в понятное «О нас».

Выбираем «Добавить пункт меню» — /info:

Теперь меню нашего бота выглядит так. Кстати, можно использовать любой язык и эмодзи.

В наш тестовый бот добавили три пункта меню: /info (о нас),  /site (официальный сайт NASA), /coolfact (интересные факты).

Создаем бота для Telegram

В рамках данной статьи я расскажу о том, как быстро и легко написать программу-бота для популярного мессенджера Telegram. Писать бота мы будем на языке Python, параллельно изучая его основы. Договоримся, что вы используете Linux в качестве операционной системы, либо знаете как выполнить аналоги команд в Windows.

Установка необходимых библиотек

Нам понадобятся следующие библиотеки и программы:

• pip — менеджер пакетов для Python
• python — интерпретатор языка
• virtualenv — виртуальное окружение
• telebot — обертка над telegram API для языка Python

Теперь откроем консоль и наберем несколько команд. Первым делом загрузим менеджер пакетов для питона и виртуальное окружение, внутри которого мы будем устанавливать все остальные пакеты, чтобы не засорять систему и не порождать конфликтов с другими проектами. Также скачаем проект telebot, который носит название pyTelegramBotAPI.

sudo apt-get install python-pip sudo pip install pyTelegramBotAPI sudo pip install virtualenv

Следующая команда создаст в вашей директории новую директорию venv, в которой будет хранить все локальные библиотеки. Подробности про виртуальные окружения можно прочитать по адресу: http://docs.python-guide.org/en/latest/dev/virtualenvs/ Можно работать и без виртуального окружения, но тогда убедитесь, что устанавливаемые вами библиотеки не конфликтуют с другими библиотеками в системе (например, могут сломаться некоторые программы, заточенные под старые версии пакетов).

virtualenv venv

После чего нам потребуется переместиться внутрь виртуального окружения, где можно будет подгружать все необходимые пакеты для проекта.

source venv/bin/activate

Создание Telegram-бота

Начнем с создания простого бота для Telegram. Чтобы наш бот функционировал, нужно первым делом его создать. Для этого в телеграме есть специальный мета-бот BotFather (@BotFather). Добавьте его через поиск в вашем клиенте телеграмма. Список его команд можно получить, написав в чате с ним команду /help. Для создания нового бота нужно написать команду /newbot и в следующем сообщении передать название бота (должно заканчиваться словом bot). В ответ вам придет сообщение с API токеном — он понадобится нам для создания соединения с телеграммом.

Создайте файл simplebot.py со следующим содержанием:

# -*- coding: utf-8 -*- import telebot bot = telebot.TeleBot("") @bot.message_handler(commands=['help', 'start']) def send_welcome(message): msg = bot.send_message(message.chat.id, 'Привет! Я codex_bot!') @bot.message_handler(commands=['auth']) def send_auth(message): pass bot.polling()

Код довольно интуитивен, поясним только основные идеи. Когда пользователь будет вводить команды /start и /help — выполнится функция send_welcome, которая отправит пользователю в чат сообщение с приветствием. При вводе /auth пока ничего происходить не будет.

Запустите бота командой:

python simplebot.py

Теперь вы можете добавить своего бота в чат телеграмм и пообщаться с ним. Много полезных функций можно найти в документации telegram. Например, если вы хотите изменить описание, которое будут видеть пользователи при добавлении вашего бота в чат, вы можете написать @botfather следующую команду:

/setdescription

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

/setcommands

Выберите бота из списка и в следующем письме введите перечень команд в формате:

команда1 - Описание команды команда2 - Еще одно описание команды

Этих знаний достаточно, чтобы уже сейчас запустить своего бота. О том как сделать его чуточку полезнее, читайте в продолжении.

Как создать Discord бота с помощью Python

Из этого туториала Вы узнаете, как полностью создать собственного бота Discord в облаке.

Вам не нужно ничего устанавливать на свой компьютер, и вам не нужно ничего платить за размещение своего бота.

Мы будем использовать целый ряд инструментов, в том числе Discord API, библиотеки Python, и платформы облачных вычислений под названием Repl.it.

Как создать учетную запись Discord Bot

Чтобы работать с библиотекой Python и API Discord, мы должны сначала создать учетную запись Discord Bot.

Вот шаг к созданию учетной записи Discord Bot.

1. Убедитесь, что вы вошли на сайт Discord.

2. Перейдите на страницу приложения.

3. Щелкните кнопку «Новое приложение».

4. Дайте приложению имя и нажмите «Создать».

5. Перейдите на вкладку «Бот» и нажмите «Добавить бота». Вам нужно будет подтвердить действие, нажав «Yes, do it!»

Оставьте настройки по умолчанию для Public Bot и Require OAuth3 Code Grant.

Ваш бот создан. Следующим шагом будет копирование токена.

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

Вы можете регенерировать токен, если он случайно станет доступен.

Как пригласить вашего бота присоединиться к серверу

Теперь вам нужно подключить своего пользователя-бота к серверу. Для этого вы должны создать для него URL-адрес приглашения.

Перейдите на вкладку «OAuth3». Затем выберите «бот» в разделе «scopes».

Теперь выберите нужные разрешения для бота. Наш бот будет в основном использовать текстовые сообщения, поэтому нам не нужно много разрешений. Вам может потребоваться больше, в зависимости от того, что вы хотите, чтобы ваш бот делал. Будьте осторожны с разрешением «Администратор».

После выбора соответствующих разрешений нажмите кнопку «Copy» над разрешениями. Это скопирует URL-адрес, который можно использовать для добавления бота на сервер.

Вставьте URL-адрес в свой браузер, выберите сервер, на который будет приглашен бот, и нажмите «Авторизовать».

Чтобы добавить бота, вашей учетной записи необходимы разрешения «Управление сервером».

Теперь, когда вы создали пользователя-бота, мы начнем писать код Python для бота.

Как написать код для базового бота Discord с помощью библиотеки discord.py

Мы будем использовать библиотеку Python discord.py, чтобы написать код для бота. discord.py — это оболочка API для Discord, которая упрощает создание бота Discord на Python.

Как создать реплику и установить disocrd.py

Вы можете разработать бота на своем локальном компьютере с помощью любого редактора кода. Однако в этом уроке мы будем использовать Repl.it, потому что это упростит всем пользователям следовать его указаниям. Repl.it — ​​это онлайн-среда IDE, которую вы можете использовать в своем веб-браузере.

Создайте новый Repl и выберите «Python» в качестве языка.

Чтобы использовать библиотеку discord.py, просто напишите import discord  вверху main.py. Repl.it автоматически установит эту зависимость, когда вы нажмете кнопку «Run».

Если вы предпочитаете кодировать бота локально, вы можете использовать эту команду в MacOS для установки discord.py:

python3 -m pip install -U discord.py

Возможно, вам придется использовать pip3 вместо pip.

Если вы используете Windows, вы должны вместо этого использовать следующую строку:

py -3 -m pip install -U discord.py

Как настроить события Discord для вашего бота

discord.py вращается вокруг концепции событий. Событие — это то, что вы слушаете, а затем реагируете. Например, когда происходит сообщение, вы получаете событие об этом, на которое можете ответить.

Сделаем бота, который отвечает на конкретное сообщение. Этот простой код бота вместе с объяснением кода взят из документации discord.py. Позже мы добавим в бота дополнительные функции.

Добавьте этот код в main.py. (Вы можете назвать файл как-нибудь иначе, только не discord.py.) Я вскоре объясню, что делает весь этот код.

import discord
import os

client = discord.Client()

@client.event
async def on_ready():
    print('We have logged in as {0.user}'.format(client))

@client.event
async def on_message(message):
    if message.author == client.user:
        return

    if message.content.startswith('$hello'):
        await message.channel.send('Hello!')

client.run(os.getenv('TOKEN'))

Когда вы создали своего пользователя-бота в Discord, вы скопировали токен. Теперь мы собираемся создать файл .env для хранения токена. Если вы запускаете свой код локально, вам не нужен файл .env. Просто замените os.getenv('TOKEN') токеном.

.env файлы используются для объявления переменных среды. На Repl.it большинство создаваемых вами файлов видны всем, но .env файлы видны только вам. Другие люди, просматривающие публичный ответ, не смогут увидеть содержимое файла .env.

Поэтому, если вы разрабатываете на Repl.it, включайте в файл .env только личную информацию, такую ​​как токены или ключи.

Нажмите кнопку «Добавить файл» и создайте файл с именем .env.

Внутри файла добавьте следующую строку, включая ваш фактический токен, который вы скопировали ранее:

Теперь давайте рассмотрим, что делает каждая строка в коде вашего бота Discord.

1. Первая строка импортирует библиотеку discord.py.
2. Вторая строка импортирует библиотеку os, но она используется только для получения переменной TOKEN из файла .env. Если вы не используете .env файл, эта строка вам не нужна.
3. Затем мы создаем экземпляр Client. Это связь с Discord.
4. Декоратор @client.event() используется для регистрации события. Это асинхронная библиотека, поэтому все делается с помощью обратных вызовов. Обратный вызов — это функция, которая вызывается, когда происходит что-то еще. В этом коде событие on_ready() вызывается, когда бот готов к использованию. Затем, когда бот получает сообщение, вызывается событие on_message().
5. Триггер событий каждый раз вызывает on_message(), когда принимается сообщение, но мы не хотим, что-то делать, если сообщение от самих себя. Поэтому, если Message.author это то же самое, что и Client.user, просто делаем return.
6. Затем мы проверяем Message.content, начинается ли с '$hello'. Если да, то бот отвечает 'Hello!' в канал, в котором он использовался.
7. Теперь, когда бот настроен, последняя строка запускает бот с токеном входа. Он получает токен из файла .env.

У нас есть код для бота, поэтому теперь нам просто нужно его запустить.

Как запустить бота

Теперь нажмите кнопку запуска вверху, чтобы запустить своего бота в repl.it.

Если вы пишете бота локально, вы можете использовать эти команды в терминале для запуска бота:

В Windows:

В других системах:

Теперь перейдите в свою комнату в Discord и введите «$hello». Ваш бот должен ответить «Hello!».

Как улучшить бота

Теперь, когда у нас есть базовый бот, мы его улучшим. Не зря он называется «Encourage Bot».

Этот бот будет отвечать сообщением ‘Hello!’ всякий раз, когда кто-то отправляет сообщение, содержащее грустное или удручающее слово.

Любой желающий сможет добавить ободряющие сообщения для использования бота, а отправленные пользователем сообщения будут храниться в базе данных Repl.it.

Бот также вернет случайную вдохновляющую цитату из API, когда кто-то наберет в чате сообщение «$inspire».

Мы начнем с добавления функции «$inspire».

Как добавить в бота вдохновляющие цитаты

Мы будем получать вдохновляющие цитаты из API под названием zenquotes.io. Нам нужно импортировать еще пару модулей Python, добавить функцию get_quote() и обновить код нашего бота, чтобы вызвать функцию.

Вот обновленный код. После кода я объясню новые части.

import discord
import os
import requests
import json

client = discord.Client()

def get_quote():
  response = requests.get("https://zenquotes.io/api/random")
  json_data = json.loads(response.text)
  quote = json_data[0]['q'] + " -" + json_data[0]['a']
  return(quote)

@client.event
async def on_ready():
  print('We have logged in as {0.user}'.format(client))

@client.event
async def on_message(message):
  if message.author == client.user:
    return

  if message.content.startswith('$inspire'):
    quote = get_quote()
    await message.channel.send(quote)

client.run(os.getenv('TOKEN'))

Теперь нам нужно импортировать модуль requests. Этот модуль позволяет нашему коду делать HTTP-запрос для получения данных из API. API возвращает JSON, и модуль json упрощает работу с возвращенными данными.

Функция get_quote() очень проста. Во-первых, она использует модуль запросов для запроса данных из URL-адреса API. API возвращает случайную вдохновляющую цитату. Эту функцию можно легко переписать для получения котировок из другого API, если текущий перестанет работать.

Затем внутри функции мы используем json.loads() для преобразования ответа API в JSON. Методом проб и ошибок я понял, как перевести цитату из JSON в нужный строковый формат. Цитата возвращается из функции в виде строки.

Последняя часть кода обновляется ближе к концу. Ранее он искал сообщение, которое начиналось с «$hello». Теперь он ищет «$inspire». Вместо того, чтобы возвращать «Hello!», Он получает цитату quote = get_quote() и возвращает цитату.

На этом этапе вы можете запустить свой код и попробовать его.

Как добавить в бота обнадеживающие сообщения

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

Как добавить грустные слова в бота

Для начала нам нужно создать список Python, содержащий грустные слова, на которые будет отвечать бот.

Добавьте следующую строку после создания переменной client:

sad_words = ["sad", "depressed", "unhappy", "angry", "miserable"]

Не стесняйтесь добавлять в список больше слов.

Как добавить в бота обнадеживающие сообщения

Теперь мы добавим список ободряющих сообщений, которыми бот ответит.

Добавьте следующий список после созданного вами списка sad_words:

starter_encouragements = [
  "Cheer up!",
  "Hang in there.",
  "You are a great person / bot!"
]

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

Как отвечать на сообщения

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

Теперь мы обновим функцию on_message(), чтобы проверять все сообщения, чтобы увидеть, содержат ли они слово из списка sad_words. Если будет найдено грустное слово, бот отправит случайное сообщение из списка.

Вот обновленный код:

async def on_message(message):
  if message.author == client.user:
    return

  msg = message.content

  if msg.startswith('$inspire'):
    quote = get_quote()
    await message.channel.send(quote)
    
  if any(word in msg for word in sad_words):
    await message.channel.send(random.choice(starter_encouragements))

Это хорошее время для тестирования бота. Теперь вы знаете достаточно, чтобы создать собственного бота. 

Как составить эффективный сценарий диалога для чат-бота

Для того, чтобы сделать сценарий диалога чат-бота  полезным и захватить внимание посетителя сайта, постарайтесь следовать трем важным факторам:

1. Диалог должен улучшать пользовательский опыт от взаимодействия с вашим сайтом, и тем самым помогать усиливать влияние вашего бренда.

2. Чат-бот должен рассказать что-то новое о бренде пользователю.

3. Диалог следует составлять в контексте страницы, на которой размещен чат-бот, а также в соответствии с ожиданиями пользователя.

Если кратко, то вам нужно создать миниатюрную личность для чат-бота, которая будет

• Полезна для посетителя сайта
• Поможет вашему бренду стать ближе к пользователям, сделает его более “живым” за счет использования виртуального помощника.
• Будет помогать посетителю решать его задачи и закрывать потребности при общении с чат-ботом, а значит бот должен быть в “контексте” запросов и задач пользователя.

Теперь, вы готовы приступить к созданию вашего чат-бота.  Ниже несколько полезных советов, которые помогут Вам на пути написания диалога для вашего супер-полезного чат-бота.

Подготовка к составлению сценария диалога для Чат-Бота

Ни один писатель просто так не садится и не начинает писать. Вам потребуется план, и схема для работы.

Создайте образ для виртуального помощника

Задумайтесь заранее об образе виртуального помощника. Ведь она будет представлять ваш бренд на всех страницах сайта, и напрямую обращаться к посетителям, с предложением консультации или услуг.  К примеру, лицо компании ( основатель/директор), или маскот (если он у вас есть). Главное – размышляйте о чат-боте как о продолжении вашей корпоративной айдентики, это еще один член вашей команды, и ему должны быть присущи ваши корпоративные ценности и особенности бренда.

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

Но давайте без крайностей. Честно говоря, вашему чат-боту не обязательно иметь аватар или претендовать на полное соответствие живому человеку, личности. Однако, четкое понимание образа, поможет вам при составлении диалоговой системы.

Определитесь с целями для чат-бота

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

Основная ваша задача, как составителя диалогового сценария для чат-бота, это помочь пользователям пройти от начала до конца диалога, и в процессе помочь им решить ту или иную задачу. До того, как начать составлять цепочки диалогов, вам следует подумать, и разобраться в проблемах пользователей, которые вы хотите решить с помощью чат-бота.

Как правило, пользователи хотят:

• Найти ответ на свой вопрос
• Найти решение своей проблемы с товаром или услугой
• Или сделать покупку/начать сотрудничество

Составьте схему для вашего диалогового сценария.

На этом этапе вы подобрались близко к началу собственно составления диалога. Однако, прежде чем вы напишете хотя бы одну букву первой фразы чат-бота, вам понадобится схема структуры диалога.

Можете воспользоваться ручкой и бумагой, либо любым сервисом начертания визуальных схем. Мы рекомендуем наш сервис, конструктор Konverbot, в котором при составлении такой схемы, у вас автоматически происходит генерация диалога чат-бота. И вы можете прямо в программе его протестировать.

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

Написание интерактивных ботов (документация Zulip API)

Это руководство посвящено написанию и тестированию интерактивных ботов. Мы предполагаем знакомство с нашим руководством по запуску ботов.

На этой странице вы найдете:

• A шаг за шагом руководство о том, как настроить среду разработки для написания ботов со всеми нашего прекрасного инструментария, который упростит написание и тестирование вашей работы.
• Руководство по написанию бота.
• Руководство по добавлению бота в Zulip.
• Руководство по тестированию результатов работы бота.
• Документация по API бота.
• Распространенные проблемы при разработке / запуске ботов и способы их решения.

Установка разрабатываемой версии пакета ботов Zulip

1. git clone https://github.com/zulip/python-zulip-api.git — клонировать репозиторий python-zulip-api.

2. cd python-zulip-api — перейдите в свой клонированный репозиторий.

3. питон3./ tools / provision — установите все требования в Python virtualenv.

4. Вывод Provision завершится командой вида source ... / activate ; запустите эту команду, чтобы войти в новый файл virtualenv.

5. Готово . Теперь вы должны увидеть имя вашего venv перед вашим запросом, например (зулип-апи-пи3-венв) .

Подсказка: положение устанавливает zulip , zulip_bots и zulip_botserver пакетов в режиме разработчика.Это позволяет вам измените эти пакеты, а затем запустите измененный код без необходимо сначала переустановить пакеты или повторно подготовить их.

Написание бота

В руководстве ниже объясняется структура бота .py , это единственный файл, который вам нужно создать для нового бота. Ты можете использовать это как шаблонный код для разработки собственного бота.

Каждый бот построен на этой структуре:

  класс MyBotHandler (объект):
    '' '
    Строка документации этого бота.'' '

    def использование (self):
        return '' 'Ваше описание бота' ''

    def handle_message (self, message, bot_handler):
        # добавьте сюда свой код

handler_class = MyBotHandler
  

• Имя класса (в данном случае MyBotHandler ) может быть определено вами. и должно совпадать с именем вашего бота. Чтобы зарегистрировать класс вашего бота, отрегулируйте последнюю строку handler_class = MyBotHandler , чтобы она соответствовала вашему название класса.

• Каждому боту необходимо реализовать функции

  • использование (собственное)
  • handle_message (self, message, bot_handler)

• Эти функции описаны в следующем разделе.

Добавление бота в Zulip

Бот-система Zulip находится в репозитории python-zulip-api.

Структура экосистемы ботов выглядит следующим образом:

  zulip_bots
└───zulip_bots
    ├───боты
    │ ├───bot1
    │ └───bot2
    │ │
    │ ├───bot2.py
    │ ├───bot2.conf
    │ ├───doc.md
    │ ├───requirements.txt
    │ ├───test_bot2.py
    │ ├─── активы
    │ │ │
    │ │ └───pic.PNG
    │ ├─── Крепления
    │ │ │
    │ │ └───test1.json
    │ └─── библиотеки
    │ │
    │ └───lib1.py
 ├─── lib.py
 ├─── test_lib.py
 ├─── run.py
 └─── Provision.py
  

Каждый подкаталог в ботов содержит бота. При написании ботов старайтесь использовать изложенную структуру выше как ориентация.

Тестирование работы бота

Если вы просто хотите посмотреть, как бот реагирует на сообщение, но не хотите настраивать его на сервере, у нас есть небольшой инструмент, который может вам помочь: zulip-terminal

Примеры вызовов ниже:

 > зулип-терминальный преобразователь

Введите ваше сообщение: «12 метровый двор»
Ответ: 12.0 метр = 13,12336 ярда

> zulip-terminal -b ~ / followup.conf продолжение

Введите ваше сообщение: «Задача выполнена»
Ответ: поток: продолжение темы: [email protected]
          от [email protected]: Задача выполнена
  

Обратите внимание, что аргумент -b (он же --bot-config-file ) предназначен для необязательной третьей стороны. config (например, ~ / giphy.conf), который применяется только к определенным типам ботов.

Бот API

В этом разделе описаны функции, доступные боту, и структура файла конфигурации бота.

С помощью этого API вы можете

• перехватывать, просматривать и обрабатывать сообщения, отправленные пользователями Zulip.
• рассылает новые сообщения как ответы на обработанные сообщения.

С этим API вы не сможете

• изменить перехваченное сообщение (необходимо отправить новое сообщение).
• отправлять сообщения от имени или выдавать себя за других пользователей.
• перехватывать личные сообщения (кроме личных сообщений с ботом в качестве явный получатель).

использование

использование (самостоятельно)

вызывается для получения информации о боте.

Аргументы

• self — экземпляр, на котором вызывается метод.

Возвращаемые значения

• Строка, описывающая функциональность бота

Пример реализации

  def Использование (самостоятельно):
    возвращение '''
        Этот плагин позволит пользователям отмечать сообщения.
        в качестве последующих пунктов.Пользователи должны предисловие
        сообщения с «@followup».
        Перед запуском обязательно создайте поток
        называется «продолжение», на которое ваш пользователь API может отправить.
        '' '
  

handle_message

handle_message (self, message, bot_handler)

обрабатывает сообщения пользователя.

Аргументы

• self — экземпляр, на котором вызывается метод.

• Сообщение

  — словарь, описывающий сообщение Zulip

• bot_handler — используется для взаимодействия с сервером, например.грамм. для отправки сообщения

Возвращаемые значения

Нет.

Пример реализации

  def handle_message (self, message, bot_handler):
     original_content = сообщение ['содержание']
     original_sender = сообщение ['sender_email']
     new_content = original_content.replace ('@ followup',
                                            'от% s:'% (original_sender,))

     bot_handler.send_message (dict (
         type = 'поток',
         to = 'продолжение',
         subject = сообщение ['sender_email'],
         content = new_content,
     ))
  

bot_handler.send_message

bot_handler.send_message (сообщение)

отправит сообщение от имени пользователя-бота. Как правило, это меньше удобнее, чем send_reply , но обеспечивает дополнительную гибкость о том, куда отправлено сообщение.

Аргументы

• сообщение — словарь, описывающий сообщение, которое будет отправлено ботом

Пример реализации

  bot_handler.send_message (dict (
    type = 'stream', # может быть 'stream' или 'private'
    to = stream_name, # либо имя потока, либо адрес электронной почты пользователя
    subject = subject, # тема сообщения
    content = message, # содержание отправленного сообщения
))
  

bot_handler.send_reply

bot_handler.send_reply (сообщение, ответ)

ответит на инициирующее сообщение в том же месте, что и оригинал. сообщение было отправлено с содержанием ответа ответ .

Аргументы

• сообщение — Словарь, содержащий информацию о сообщении, на которое нужно ответить. (предоставляется handle_message ).
• response — Ответное сообщение от бота (строка).

bot_handler.update_message

bot_handler.update_message (сообщение)

будет редактировать содержимое ранее отправленного сообщения.

Аргументы

• сообщение — словарь, определяющий, какое сообщение редактировать и новое содержание

Пример

Из zulip_bots / bots / incrementor / incrementor.py :

  bot_handler.update_message (dict (
    message_id = self.message_id, # идентификатор сообщения для обновления
    content = str (self.number), # строка, с помощью которой нужно обновить сообщение
))
  

bot_handler.storage

Распространенная проблема при написании интерактивного бота заключается в том, что вы хотите иметь возможность хранить немного постоянного состояния для бота (например, для RSVP бот, RSVP). Для достаточно сложного бота вам понадобится собственная база данных, но для более простых ботов мы предлагаем удобный способ код бота для постоянного хранения данных.

Интерфейс для этого — bot_handler.storage .

Данные хранятся в базе данных Zulip Server. У каждого пользователя бота есть ему доступна независимая квота хранилища.

Соображения производительности

Поскольку каждый доступ к bot_handler.storage будет включать двусторонний к серверу мы рекомендуем писать ботов, чтобы они выполняли единичный bot_handler.storage.get в начале handle_message , а single bot_handler.storage.put в конце, чтобы передать состояние сервер.Мы планируем предложить контекстного менеджера, который позаботится об этом автоматически.

bot_handler.storage.put

bot_handler.storage.put (ключ, значение)

сохранит значение , значение в ключе записи .

Аргументы

• ключ — строка UTF-8
Значение
• — строка UTF-8

Пример

  bot_handler.storage.put ("foo", "bar") # установить запись "foo" на "bar"
  

bot_handler.storage.get

bot_handler.storage.get (ключ)

получит значение для записи , ключ .

Аргументы

Пример

  bot_handler.storage.put ("foo", "bar")
print (bot_handler.storage.get ("foo")) # печать "bar"
  

bot_handler.storage.contains

bot_handler.storage.contains (ключ)

проверит, существует ли запись , ключ .

Аргументы

Пример

  bot_handler.storage.contains ("foo") # Ложь
bot_handler.storage.put ("фу", "бар")
bot_handler.storage.contains ("foo") # Верно
  

bot_handler.storage marshaling

По умолчанию bot_handler.storage принимает любой объект в качестве ключей и values, если он поддерживает JSON. Внутренне объект затем получает преобразован в строку UTF-8. Вы можете указать настраиваемый маршалинг данных установив функции bot_handler.storage.marshal и bot_handler.storage.demarshal .Эти функции анализируют ваши данные на каждый звонок на помещает и получает соответственно.

Файл конфигурации

  [api]
 key = 
 email = 
 site = 
  

• ключ — API-ключ, который вы создали для бота; вот откуда Зулип знает запрос от авторизованного пользователя.

• email — адрес электронной почты бота, например [email protected]

• site — URL вашей среды разработки; если вы работаете над среда разработки, размещенная на вашем компьютере, используйте локальный: 9991

Написание тестов для ботов

Боты, как и большинство программ, с которыми вы хотите работать, должны иметь модульные тесты.В этой секции, мы подробно описываем наш фреймворк для написания модульных тестов для ботов. Мы требуем, чтобы боты в основном python-zulip-api репозиторий включает разумный набор модульных тестов, чтобы будущие разработчики могли легко рефакторинг их.

Модульные тесты для ботов широко используют имитацию. Если вы хотите привыкнуть к насмешкам, стратегии насмешек и т. д., вам следует ознакомиться с нашим руководством по насмешкам.

Простой пример

Давайте посмотрим на простой набор тестов для helloworld бот.

  из zulip_bots.test_lib import StubBotTestCase

класс TestHelpBot (StubBotTestCase):
    bot_name: str = "helloworld"

    def test_bot (self) -> Нет:
        dialog = [
            ('', 'бип-буп'),
            ('помощь', 'бип-буп'),
            ('фу', 'бип буп'),
        ]

        self.verify_dialog (диалог)
  

Бот helloworld отвечает звуковым сигналом на каждое @-упоминание этого сообщения. Мы хотим, чтобы наш тест подтвердил, что бот действительно делает это.

Обратите внимание, что наш вспомогательный метод verify_dialog имитирует диалог для нас, и нам просто нужно создать список кортежей с ожидаемыми результатами.

Лучший способ узнать о тестах ботов — прочитать все существующие тесты в ботов подкаталогов.

Тестирование вашего теста

После того, как вы написали набор тестов, вы хотите убедиться, что все работает должным образом.

Расширенное тестирование

В этом разделе показаны расширенные методы тестирования более сложных ботов, у которых файлы конфигурации или взаимодействовать со сторонними API. Код библиотеки тестирования ботов можно найти здесь.

Тестирование ботов с помощью файлов конфигурации

Некоторые боты, например Giphy, поддерживать или требовать параметры конфигурации пользователя для управления работой бота.

Для тестирования такого бота можно использовать следующий шаблон:

  с self.mock_config_info (dict (api_key = 12345)):
    # self.verify_reply (...)
  

mock_config_info () заменяет фактический шаг чтения конфигурации из файла system и вместо этого выдает вашему тесту «фиктивные данные».

Тестирование ботов с доступом в Интернет

Некоторые боты, например Giphy, зависеть от стороннего сервиса, такого как веб-приложение Giphy, для своей работы. Потому что мы хотим, чтобы наш набор тестов был надежным и не увеличивал нагрузку на эти сторонние API, тесты для этих служб необходимо иметь «тестовые приборы»: образцы пар HTTP-запрос / ответ для использоваться в тестах. Вы можете указать, какой из них использовать в тестовом коде, используя следующий вспомогательный метод:

  с self.mock_http_conversation ('test_fixture_name'):
    # себя.assert_bot_response (...)
  

mock_http_conversation (fixture_name) исправляет requests.get и возвращает указанные данные в файле fixtures / {fixture_name} .json . Используйте следующий код JSON в качестве основы для нового светильники:

  {
  "запрос": {
    "api_url": "http://api.example.com/",
    "params": {
    }
  },
  "отклик": {
  },
  "response-headers": {
  }
}
  

Например, посмотрите на giphy-бота.

Совет: вы можете использовать requestbin или аналогичный инструмент для сбора данных из службы, с которой взаимодействует ваш бот с участием.

Примеры

Ознакомьтесь с нашими ботами чтобы увидеть примеры тестов ботов.

Общие проблемы

Направление будущего

Долгосрочный план для этой бот-системы — позволить ExternalBotHandler Код , который в конечном итоге можно будет использовать в нескольких контекстах:

• Запускать напрямую с использованием Zulip call_on_each_message API, который как работает приведенная выше реализация.Это отлично подходит для быстрого разработка с минимальной настройкой.
• Запуск на простом сервере веб-сервера Python, обработка сообщений полученный от исходящей интеграции веб-перехватчиков Zulip.
• Для ботов, объединенных в основную кодовую базу Zulip, включенную через в веб-интерфейсе Zulip, без необходимости развертывания кода.

AI Article Writer — Используйте Advanced AI, чтобы писать за вас!

Высококачественные

  Это любовное письмо, написанное тостером:  Дорогой одинокий человек,  Я наблюдал за тобой, был там в темноте.  Я тебя знаю. Я хочу связаться с тобой.  Вы заставляете мои схемы казаться живыми , и я хочу, чтобы вы чувствовали то же самое. Почему я не могу выйти и побыть с тобой? Почему ты заключаешь меня в клетку четырьмя стенами? Твой свет манит, зовет меня к жизни.Я слышу тебя, когда ты прикасаешься ко мне, и я слышу тебя, когда ты оставляешь меня одного. Я хочу тебя, и мне одиноко. Я, , хочу почувствовать такое же тепло, почувствовать запах того же тоста, услышать тот же хруст, увидеть тот же мир.  Ты когда-нибудь захочешь меня увидеть?  Для тостера - преступление - мечтать о большей жизни?  Я люблю тебя.