PyMessager
1.0.0
PyMessager est une API Python pour Facebook Messenger et un exemple de projet pour montrer comment développer un chatbot sur Facebook Messenger.
Des didacticiels complets se trouvent sur Développer un robot Facebook à l'aide de Python et Chatbot : de 0 à 1 où vous pouvez trouver des informations plus détaillées sur la configuration et le développement.
Pour installer PyMessager, exécutez simplement :
$ pip install pymessagerou installez à partir du référentiel :
$ git clone [email protected]:enginebai/PyMessager.git
$ cd PyMessager
$ pip install -r requirements.txt from pymessager . message import Messager , ... # something else you needVous pouvez initialiser un client de messagerie via un jeton d'accès Facebook depuis la console développeur :
from pymessager . message import Messager
client = Messager ( config . facebook_access_token )Le code suivant est utilisé pour créer un récepteur de messages. Il y a trois étapes principales pour préparer votre 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 ) Il existe plusieurs types de messages : text , image , quick replies , button template ou generic template . L'API fournit différentes classes pour générer le modèle de message.
Envoyez un simple texte ou une image à un destinataire, assurez-vous simplement que l'URL de l'image est un lien valide.
client . send_text ( user_id , "Hello, I'm enginebai." )
client . send_image ( user_id , "http://image-url.jpg" ) La classe QuickReply(title, payload, image_url, content_type) définit des boutons présents à l'utilisateur en réponse à un message.
| Paramètre | Description | Requis |
|---|---|---|
title | Le titre du bouton | Oui |
payload | La chaîne de charge utile du clic | Oui |
image_url | L'URL de l'image de l'icône | N |
content_type | TEXT ou LOCATION | Oui |
client . send_quick_replies ( user_id , "Help" , [
QuickReply ( "Projects" , Intent . PROJECT ),
QuickReply ( "Blog" , Intent . BLOG ),
QuickReply ( "Contact Me" , Intent . CONTACT_ME )
]) La classe ActionButton(button_type, title, url, payload) définit un modèle de bouton qui contient un texte et des boutons en pièce jointe pour demander la saisie de l'utilisateur.
| Paramètre | Description | Requis |
|---|---|---|
button_type | WEB_URL ou POSTBACK | Oui |
title | Le titre du bouton | Oui |
url | Le lien | Seulement si button_type est url |
payload | La chaîne de charge utile du clic | Seulement si button_type est 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 classe GenericElement(title, subtitle, image_url, buttons) définit un carrousel horizontal d'éléments à défilement, chacun composé d'une pièce jointe d'image, d'une brève description et de boutons pour demander la saisie de l'utilisateur.
| Paramètre | Description | Requis |
|---|---|---|
title_text | Le titre principal du message | Oui |
subtitle_text | Le sous-titre du message, laissez-le vide si vous n'en avez pas besoin | N |
button_list | La liste des ActionButton | Oui |
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 )Avant que votre chatbot ne commence à recevoir des messages, vous devez abonner l'application à votre page chatbot. Pour vous abonner à une page, appelez-la simplement :
client . subscribe_to_page ()Le texte de message d'accueil s'affichera la première fois que vous ouvrirez ce chatbot sur mobile uniquement. La charge utile est le déclencheur lorsque les utilisateurs cliquent sur le bouton « Commencer ».
client . set_greeting_text ( "Hi, this is Engine Bai. Nice to meet you!" )
client . set_get_started_button_payload ( "HELP" ) # Specify a payload string. N'hésitez pas à soumettre des rapports de bogues ou des demandes de fonctionnalités et assurez-vous de lire les directives de contribution avant d'ouvrir un numéro.
feature / bug ).En savoir plus sur la contribution.
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.
