PyMessager

PyMessager

PyMessager — это API Python для Facebook Messenger и пример проекта, демонстрирующий разработку чат-бота в Facebook Messenger.

Полные руководства находятся в разделе «Разработка бота Facebook с использованием Python и Chatbot: от 0 до 1», где вы можете найти более подробную информацию для настройки и разработки.

Прежде чем начать

1. Подготовьте страницу Facebook. (создать, если у вас его нет)
2. Создайте приложение разработчика на Facebook для разработчиков.
3. Запустите проект Python и установите необходимые пакеты и модули: Flask, Requests.
4. Используйте Let’s Encrypt, чтобы применить SSL-сертификацию для вашего доменного имени.

Установить

Чтобы установить PyMessager, просто запустите:

$ pip install pymessager

или установить из репозитория:

$ git clone [email protected]:enginebai/PyMessager.git
$ cd PyMessager
$ pip install -r requirements.txt

Начать

Импорт

 from pymessager . message import Messager , ... # something else you need

Инициализация

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

 from pymessager . message import Messager
client = Messager ( config . facebook_access_token )

API-интерфейсы приемника

Следующий код используется для создания приемника сообщений. Подготовка бота состоит из трех основных шагов:

1. Настройте вебхук

 @ app . route ( API_ROOT + FB_WEBHOOK , methods = [ "GET" ])
def fb_webhook ():
    verification_code = 'I_AM_VERIFICIATION_CODE'
    verify_token = request . args . get ( 'hub.verify_token' )
    if verification_code == verify_token :
        return request . args . get ( 'hub.challenge' )

2. Получить сообщение

 @ app . route ( API_ROOT + FB_WEBHOOK , methods = [ 'POST' ])
def fb_receive_message ():
    message_entries = json . loads ( request . data . decode ( 'utf8' ))[ 'entry' ]
    for entry in message_entries :
        for message in entry [ 'messaging' ]:
            if message . get ( 'message' ):
                print ( "{sender[id]} says {message[text]}" . format ( ** message ))
    return "Hi"

3. Запустите сервер с https

 if __name__ == '__main__' :
    context = ( 'ssl/fullchain.pem' , 'ssl/privkey.pem' )
    app . run ( host = '0.0.0.0' , debug = True , ssl_context = context )

API-интерфейсы отправителя

Существует несколько типов сообщений: text , image , quick replies , button template или generic template . API предоставляет различные классы для создания шаблона сообщения.

Отправка текста и изображения

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

 client . send_text ( user_id , "Hello, I'm enginebai." )
client . send_image ( user_id , "http://image-url.jpg" )

Быстрые ответы

Класс QuickReply(title, payload, image_url, content_type) определяет кнопки отображения пользователю в ответ на сообщение.

Параметр	Описание	Необходимый
title	Название кнопки	Да
payload	Строка полезной нагрузки клика	Да
image_url	URL-адрес изображения значка	Н
content_type	TEXT или LOCATION	Да

 client . send_quick_replies ( user_id , "Help" , [
         QuickReply ( "Projects" , Intent . PROJECT ),
         QuickReply ( "Blog" , Intent . BLOG ),
         QuickReply ( "Contact Me" , Intent . CONTACT_ME )
     ])

Шаблон кнопки

Класс ActionButton(button_type, title, url, payload) определяет шаблон кнопки, который содержит вложение текста и кнопок для запроса ввода от пользователя.

Параметр	Описание	Необходимый
button_type	WEB_URL или POSTBACK	Да
title	Название кнопки	Да
url	Ссылка	Только если button_type — это url
payload	Строка полезной нагрузки клика	Только если button_type имеет POSTBACK

 client . send_buttons ( user_id , "You can find me with below" , [
    ActionButton ( ButtonType . WEB_URL , "Blog" , "http://blog.enginebai.com" ),
	ActionButton ( ButtonType . POSTBACK , "Email" , Intent . EMAIL )
])

Общий шаблон

Класс GenericElement(title, subtitle, image_url, buttons) определяет горизонтальную прокручиваемую карусель элементов, каждый из которых состоит из вложения изображения, краткого описания и кнопок для запроса ввода от пользователя.

Параметр	Описание	Необходимый
title_text	Основной заголовок сообщения	Да
subtitle_text	Подзаголовок сообщения, оставьте его пустым, если он вам не нужен.	Н
button_list	Список ActionButton	Да

 project_list = []
for project_id , project in projects . items ():
    project_list . append ( GenericElement (
        project [ "title" ],
        project [ "description" ],
        config . api_root + project [ "image_url" ], [
            ActionButton ( ButtonType . POSTBACK ,
                         self . _get_string ( "button_more" ),
                         # Payload use Intent for the beginning
                         payload = Intent . PROJECTS . name + project_id )
        ]))
client . send_generic ( user_id , project_list )

API-интерфейсы утилит

Подпишитесь на страницы

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

 client . subscribe_to_page ()

Установите приветственное сообщение и кнопку «Начало работы»

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

 client . set_greeting_text ( "Hi, this is Engine Bai. Nice to meet you!" )
client . set_get_started_button_payload ( "HELP" )  # Specify a payload string. 

Проблемы

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

Содействие

1. Проверьте открытые/закрытые проблемы или откройте новую проблему для запроса функции или отчета об ошибке с разными метками ( feature / bug ).
2. Создайте форк этого репозитория на GitHub, чтобы начать настройку основной или новой ветки.
3. Напишите тест, который покажет, что функция работает должным образом или ошибка исправлена.
4. Отправьте запрос на включение и дождитесь проверки кода.

Узнайте больше о вкладе.

Лицензия

 The MIT License (MIT)

Copyright © 2017 Engine Bai.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.