Pymessager
1.0.0
Pymessager - это Python API для Facebook Messenger и образцовый проект, чтобы продемонстрировать, как разработать чат -бот на Facebook Messenger.
Полные учебные пособия находятся на разработке бота в Facebook с использованием Python и Chatbot: от 0 до 1, где вы можете найти более подробную информацию для настройки и разработки.
Чтобы установить 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Вы можете инициализировать клиента Messager через токен доступа к Facebook от консоли разработчика:
from pymessager . message import Messager
client = Messager ( config . facebook_access_token )Следующий код используется для создания приемника сообщений, есть три основных шага для подготовки для вашего бота:
@ 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' ) @ 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" if __name__ == '__main__' :
context = ( 'ssl/fullchain.pem' , 'ssl/privkey.pem' )
app . run ( host = '0.0.0.0' , debug = True , ssl_context = context ) Существует несколько типов сообщений: 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 | Строка PILELOAD CLICK | У |
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 | Строка PILELOAD CLICK | Только если 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 )Прежде чем ваш чат -бот начнет получать сообщения, вы должны подписаться на приложение на страницу Chatbot. Чтобы подписаться на страницу, просто назовите ее:
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. Не стесняйтесь отправлять отчеты об ошибках или запросы на функции и убедитесь, что вы прочитали руководство взноса перед открытием любой проблемы.
feature / bug ).Узнайте больше о вклад.
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.
