Pymessager
1.0.0
Pymessager es una API de Python para Facebook Messenger y un proyecto de muestra para demostrar cómo desarrollar un chatbot en Facebook Messenger.
Los tutoriales completos están en desarrollar un bot de Facebook usando Python y Chatbot: de 0 a 1, donde puede encontrar información más detallada para configurar y desarrollar.
Para instalar Pymessager, simplemente ejecute:
$ pip install pymessagero instalar desde el repositorio:
$ git clone [email protected]:enginebai/PyMessager.git
$ cd PyMessager
$ pip install -r requirements.txt from pymessager . message import Messager , ... # something else you needPuede inicializar un cliente Messager a través de un token de acceso de Facebook desde la consola de desarrolladores:
from pymessager . message import Messager
client = Messager ( config . facebook_access_token )El siguiente código se usa para crear un receptor de mensajes, hay tres pasos principales para prepararse para su bot:
@ 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 ) Hay varios tipos de mensajes: text , image , quick replies , button template o generic template . API proporciona diferentes clases para generar la plantilla de mensaje.
Envíe un texto simple o una imagen a un destinatario, solo asegúrese de que la URL de la imagen sea un enlace válido.
client . send_text ( user_id , "Hello, I'm enginebai." )
client . send_image ( user_id , "http://image-url.jpg" ) La clase QuickReply(title, payload, image_url, content_type) define los botones presentes al usuario en respuesta a un mensaje.
| Parámetro | Descripción | Requerido |
|---|---|---|
title | El título del botón | Y |
payload | La cadena de carga de clics de clic | Y |
image_url | La url de la imagen del icono | norte |
content_type | TEXT o LOCATION | Y |
client . send_quick_replies ( user_id , "Help" , [
QuickReply ( "Projects" , Intent . PROJECT ),
QuickReply ( "Blog" , Intent . BLOG ),
QuickReply ( "Contact Me" , Intent . CONTACT_ME )
]) La clase ActionButton(button_type, title, url, payload) Define la plantilla de botón que contiene un archivo adjunto de texto y botones para solicitar la entrada del usuario.
| Parámetro | Descripción | Requerido |
|---|---|---|
button_type | WEB_URL o POSTBACK | Y |
title | El título del botón | Y |
url | El enlace | Solo si button_type es url |
payload | La cadena de carga de clics de clic | Solo si button_type es 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 )
]) La clase GenericElement(title, subtitle, image_url, buttons) define un carrusel horizontal desplazable de elementos, cada uno compuesto por un archivo adjunto de imagen, una descripción breve y botones para solicitar la entrada del usuario.
| Parámetro | Descripción | Requerido |
|---|---|---|
title_text | El título principal del mensaje | Y |
subtitle_text | El subtítulo del mensaje, déjelo vacío si no lo necesita | norte |
button_list | La lista de ActionButton | Y |
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 )Antes de que su chatbot comience a recibir mensajes, debe suscribir la aplicación a su página de chatbot. Para suscribir una página, solo llámelo:
client . subscribe_to_page ()El texto de saludo se mostrará por primera vez que abra este chatbot solo en dispositivos móviles. La carga útil es el desencadenante cuando los usuarios hacen clic en el botón "Comenzar".
client . set_greeting_text ( "Hi, this is Engine Bai. Nice to meet you!" )
client . set_get_started_button_payload ( "HELP" ) # Specify a payload string. No dude en enviar informes de errores o solicitudes de funciones y asegúrese de leer la guía de contribución antes de abrir cualquier problema.
feature / bug ).Lea más sobre contribuir.
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.
