/ viber-бот-питон

Используйте эту библиотеку для разработки бота для платформы Viber. Библиотека доступна на GitHub , а также пакет на PyPI.

Этот пакет можно импортировать с помощью pip, добавив в ваш requirements.txt следующее:

 viberbot == 1.0.11 

Лицензия

Эта библиотека выпущена в соответствии с условиями лицензии Apache 2.0. Дополнительную информацию см. В разделе «Лицензия».

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

1. python> = 2.7.0
2. Активная учетная запись Viber на платформе, которая поддерживает публичные учетные записи/ботов (iOS/Android). Эта учетная запись будет автоматически назначена администратором учетной записи в процессе создания учетной записи.
3. Активная общедоступная учетная запись/бот – создайте учетную запись здесь.
4. Токен аутентификации учетной записи – уникальный идентификатор учетной записи, используемый для проверки вашей учетной записи во всех запросах API. Как только ваша учетная запись будет создана, ваш токен аутентификации появится на экране «Изменить информацию» учетной записи (только для администраторов). Каждый запрос, отправленный в Viber учетной записью, должен содержать токен.
5. Webhook – используйте URL-адрес конечной точки сервера, поддерживающий HTTPS. При развертывании на собственном настраиваемом сервере вам понадобится доверенный (ca.pem) сертификат, а не самозаверяющий. Прочтите в нашем блоге о том, как протестировать своего бота локально.

Приступим!

Установка

Создать базового бота Viber просто:

1. Установите библиотеку с помощью pip pip install viberbot
2. Импортируйте библиотеку viberbot.api в свой проект
3. Создайте общедоступную учетную запись или бота и используйте API ключ от https://developers.viber.com
4. Настройте своего бота, как описано в документации ниже.
5. Запустите веб-сервер
6. Вызов set_webhook (url) с URL-адресом вашего веб-сервера

Простой Echo Bot

Во-первых, давайте импортируем и настроим нашего бота

 из viberbot import Apifrom viberbot.api.bot_configuration import BotConfigurationbot_configuration = BotConfiguration (  name = 'PythonSampleBot', avatar = 'http://viber.com/avatar.jpg', auth_token = 'YOUR_AUTH_TOKEN_HERE') viber = Api (bot_configuration) 

Создайте сервер HTTPS

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

 из flask import Flask, request, Responseapp = Flask (__ name __) @ app  .route ('/incoming', methods = ['POST']) def incoming (): logger.debug ("Полученный запрос. Данные публикации: {0}". format (request.get_data ())) # обрабатываем запрос  здесь return Response (status = 200) context = ('server.crt', 'server.key') app.run (host = '0.0.0. 0 ', port = 443, debug = True, ssl_context = context) 

Установка веб-перехватчика

После сервер запущен и работает, вы можете установить веб-перехватчик. Viber будет отправлять сообщения, отправленные на этот URL. веб-сервер должен иметь выход в Интернет.

 viber.set_webhook ('https://mybotwebserver.com:443/') 

Ведение журнала

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

 logger = logging.getLogger () logger.setLevel (logging.DEBUG) handler = logging.StreamHandler () formatter  = logging.Formatter ('% (asctime) s -% (name) s -% (levelname) s -% (message) s') handler.setFormatter (formatter) logger.addHandler (handler) 

Предоставляете ли вы основные типы сообщений?

Ну, забавно спросите вы. Да. Все типы сообщений находятся в пакете viberbot.api.messages . Вот несколько примеров:

 из viberbot.api.messages import (TextMessage, ContactMessage, PictureMessage, VideoMessage) из viberbot.api.messages.data_types.contact import Contact # создание текста  messagetext_message = TextMessage (text = "образец текстового сообщения!") # создание контактного сообщенияcontact = Contact (name = "Viber user", phone_number = "0123456789") contact_message = ContactMessage (contact = contact) # создание графического сообщенияpicture_message = PictureMessage (  text = "Проверить это", media = "http://site.com/img.jpg") # создание видеосообщенияvideo_message = VideoMessage (media = "http://mediaserver.com/video.mp4", size = 4324  ) 

Вы заметили, как мы создали TextMessage ? Вам следует ознакомиться со множеством типов сообщений.

• Текстовое сообщение
• URL-адрес сообщения
• Контакт Сообщение
• Сообщение с изображением
• Видео сообщение
• Сообщение о местоположении
• Сообщение-стикер
• Сообщение Rich Media
• Сообщение с клавиатуры

Создать их очень просто! У каждого объекта сообщения есть собственный уникальный конструктор, соответствующий его реализации API, щелкните по ним, чтобы увидеть его! Ознакомьтесь с полной документацией по API для более продвинутого использования.

Давайте сложим все это и ответим сообщением!

 from flask import Flask, request, Responsefrom viberbot import Apifrom viberbot.api.bot_configuration import BotConfigurationfrom viberbot.api.messages import VideoMessagefrom  viberbot.api.messages.text_message импорта TextMessageimport loggingfrom viberbot.api.viber_requests импортировать ViberConversationStartedRequestfrom viberbot.api.viber_requests импорта ViberFailedRequestfrom viberbot.api.viber_requests импортировать ViberMessageRequestfrom viberbot.api.viber_requests импортировать ViberSubscribedRequestfrom viberbot.api.viber_requests импортировать ViberUnsubscribedRequestapp = кОЛБУ (__ name__)  viber = Api (BotConfiguration (name = 'PythonSampleBot', avatar = 'http://site. com/avatar.jpg ', auth_token =' 445da6az1s345z78-dazcczb2542zv51a-e0vc5fva17480im9 ')) @ app.route ('/', methods = [' POST ']) def incoming (): logger.debug ("получил запрос. данные публикации  : {0} ". Format (request.get_data ())) # каждое сообщение viber подписано, вы можете проверить подпись с помощью этого метода, если не viber.verify_signature (request.get_data (), request.headers.get ('X  -Viber-Content-Signature ')): return Response (status = 403) # эта библиотека предоставляет простой способ получить объект запроса viber_request = viber.parse_request (request.get_data ()) if isinstance (viber_request, ViberMessageRequest): message  = viber_request.message # позволяет вернуть эхо viber.send_messages (viber_request.sender.id, [message]) elif isinstance (viber_request, ViberSubscribedRequest): viber.send_messages (viber_request.get_user.id, text = "спасибо за подписку!"  ")]) elif isinstance (viber_request, ViberFailedRequest): logger.warn (" клиент не получил сообщение. ошибка: {0} ". format (viber_request)) return Response (st  atus = 200) if __name__ == "__main__": context = ('server.crt', 'server.key') app.run (host = '0.0.0.0', port = 443, debug = True, ssl_context = context  ) 

Как видите, существует несколько типов Request , вот их список.

Viber API

Api class

из viberbot import Api

• Api
  • init (bot_configuration)
  • .set_webhook (url, webhook_events) ⇒ Список зарегистрированных_типов событий
  • .unset_webhook () ⇒ Нет
  • .get_account_info () ⇒ объект
  • .verify_signature (данные_запроса, подпись) ⇒ boolean
  • .parse_request (request_data) ⇒ ViberRequest
  • .send_messages (to, messages) ⇒ список отправленных токенов сообщений
  • .get_online (viber_user_ids) ⇒ словарь статусов пользователей
  • .get_user_details (viber_user_id) ⇒ словарь пользователя da ta
  • .post_messages_to_public_account (to, messages) ⇒ список отправленных токенов сообщений

Новый API ()

Api.set_webhook (url)

Возвращает Список зарегистрированных_типов событий .

 event_types = viber. set_webhook ('https://example.com/incoming') 

Api.unset_webhook ()

Возвращает None.

viber.unset_webhook()

Api.get_account_info ()

Возвращает объект со следующим JSON.

 account_info = viber.get_account_info () 

Api.verify_signature (данные_запроса, подпись)

Возвращает логическое , предлагающее правильность подписи.

, если не viber.verify_signature (request.get_data (),  request.headers.get ('X-Viber-Content-Signature'))  : return Response (status = 403) 

Api.parse_request (request_data)

Возвращает объект ViberRequest .

Есть список ViberRequest объекты

 viber_request = viber.parse_request (request.get_data ()) 

Api.send_messages (to, messages)

Возвращает список токенов отправленных сообщений.

 tokens = viber.send_messages (to = v  iber_request.get_sender (). get_id (), messages = [TextMessage (text = "образец сообщения")]) 

Api.post_messages_to_public_account (to, messages)

Возвращает список токенов отправленных сообщений.

 tokens = viber.post_messages_to_public_account (sender = viber_request.get_sender (). get_id (), messages  = [TextMessage (text = "образец сообщения")]) 

Api. get_online (viber_user_ids)

Возвращает словарь пользователей .

 users = Api.get_online (["user1id", "user2id"]) 

Api.get_user_details (viber_user_id)

get_user_details функция будет получать данные о конкретном пользователе Viber на основе его уникального идентификатора пользователя. Идентификатор пользователя может быть получен из обратных вызовов, отправленных в учетную запись относительно действий пользователя. Этот запрос может быть отправлен дважды в течение 12 часов для каждого идентификатора пользователя.

 user_data = Api.get_user_details ("userId") 

Объект запроса

• ViberRequest
  • .event_type ⇒ string
  • .timestamp ⇒ long

ViberConversationStartedRequest объект

Наследуется от ViberRequest

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

Это событие не считается событие подписки и не позволяет учетной записи отправлять сообщения пользователю; однако это позволит отправить пользователю одно «приветственное сообщение». См. Отправку приветственного сообщения ниже для получения дополнительной информации.

• ViberConversationStartedRequest
  • токен_сообщения ⇒ string
  • тип ⇒ string
  • контекст ⇒ string
  • user ⇒ UserProfile

Объект ViberDeliveredRequest

Наследуется от ViberRequest

• ViberDeliveredRequest
  • message_token ⇒ string
  • user_id ⇒ string

объект ViberFailedRequest

Наследуется от ViberRequest

• ViberFailedRequest
  • токен_сообщения ⇒ string
  • user_id ⇒ string
  • desc ⇒ строка

объект ViberMessageRequest

Наследует из ViberRequest

• ViberMessageRequest
  • токен_сообщения ⇒ string
  • message ⇒ Message
  • отправитель ⇒ UserProfile

объект ViberSeenRequest

Наследуется от ViberRequest

• ViberSeenRequest
  • токен_сообщения ⇒ string
  • user_id ⇒ string

Объект ViberSubscribedRequest

Наследуется от ViberRequest

• ViberSubscribedRequest
  • user ⇒ UserProfile

Объект ViberUnsubscribedRequest

Наследуется от ViberRequest

• ViberUnsubscribedRequest
  • get_user_id () ⇒ строка

объект UserProfile

Объект сообщения

Общие члены для интерфейса Message :

Общие аргументы конструктора Message interface :

объект TextMessage

 message = TextMessage (  text = "мое текстовое сообщение") 

объект URLMessage

 message = URLMessage (media = "http://my.siteurl.com") 

объект ContactMessage

 из viberbot.api.messages.data_types.contact import Contactcontact = Contact (name = "Пользователь Viber"  , phone_number = "+ 0015648979", avatar = "http://link.to. аватар ") contact_message = ContactMessage (contact = contact) 

Объект PictureMessage

 message = PictureMessage (media = "http://www.thehindubusinessline.com/multimedia/dynamic/01458/viber_logo_JPG_1458024f.jpg"  , text = "Viber logo") 

объект VideoMessage

 message = VideoMessage (media = "http://site.  com/video.mp4 ", size = 21499) 

Объект LocationMessage

 из viberbot.api.messages.data_types.location import Locationlocation = Location (lat = 0.0, lon = 0.0) location_message = LocationMessage (location = location) 

объект StickerMessage

 message = StickerMessage (sticker_id = 40100) 

Объект FileMessage

 message = FileMessage (media = url, size = sizeInBytes  , имя_файла = имя_файла) 

объект RichMediaMessage

 SAMPLE_RICH_MEDIA  = "" "{" BgColor ":" # 69C48A "," Buttons ": [{" Columns ": 6," Rows ": 1," BgColor ":" # 454545 "," BgMediaType ":" gif ","  BgMedia ":" http://www.url.by/test.gif "," BgLoop ": true," ActionType ":" open-url "," Silent ": true," ActionBody ":" www.tut. by "," Image ":" www.tut.by/img.jpg "," TextVAlign ":" middle "," TextHAlign ":" left "," Text ":"  пример  кнопки "  , "TextOpacity": 10, "TextSize": "обычный"}]} "" "SAMPLE_ALT_TEXT =" обновить сейчас! "Message = RichMediaMessage (rich_media = SAMPLE_RICH_MEDIA, alt_text = SAMPLE_ALT_TEXT) 

объект KeyboardMessage

 message = KeyboardMessage (tracking_data = tracking_data, keyboard = keyboard) 

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

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

Приветственное сообщение будет отправлено как ответ на talk_started , который будет получен от Viber, когда пользователь откроет беседу с учетной записью. Чтобы узнать больше об этом событии и когда оно запускается, см. Разговор начался в разделе обратных вызовов.

Приветственное сообщение

Отправка приветственного сообщения будет выполняться в соответствии со следующей процедурой:

1. Пользователь открывает беседу один на один с учетной записью.
2. Сервер Viber отправляет диалог_запущен даже на веб-перехватчик PA.
3. Учетная запись получает диалог_начало и отвечает HTTP-ответ, который включает приветственное сообщение в качестве тела ответа.

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

 @ app.route ('/', methods = ['POST']) def incoming (): viber_request = viber.parse_request  (request.get_data ()) if isinstance (viber_request, ViberConversationStartedRequest): viber.send_messages (viber_request.get_user (). get_id (), [TextMessage (text = "Добро пожаловать!")]) return Response (status = 200) 

Сообщество

Присоединяйтесь к обсуждению на Gitter .