PyMessager

PyMessager

PyMessager ist eine Python -API für Facebook Messenger und ein Beispielprojekt, um zu demonstrieren, wie man einen Chatbot auf Facebook Messenger entwickelt.

Komplette Tutorials finden Sie in der Entwicklung eines Facebook -Bots mit Python und Chatbot: von 0 bis 1, wo Sie detailliertere Informationen zum Einrichten und Entwickeln finden.

Vor dem Start

1. Bereiten Sie eine Facebook -Seite vor. (Erstellen, wenn Sie keine haben)
2. Erstellen Sie eine Entwickleranwendung auf Facebook für Entwickler.
3. Starten Sie ein Python -Projekt und installieren Sie die erforderlichen Pakete und Module: Flask, Anfragen.
4. Verwenden Sie Let Let Lecrypt, um die SSL -Zertifizierung für Ihren Domain -Namen anzuwenden.

Installieren

Um PyMessager zu installieren, rennen Sie einfach:

$ pip install pymessager

oder aus dem Repository installieren:

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

Fangen an

Import

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

Initialisierung

Sie können einen Messager -Client über ein Facebook -Zugriffs -Token aus der Entwicklerkonsole initialisieren:

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

Empfänger -APIs

Der folgende Code wird verwendet, um einen Nachrichtenempfänger zu erstellen. Es gibt drei Hauptschritte, um sich auf Ihren Bot vorzubereiten:

1. Richten Sie das Webhook ein

 @ 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. Empfangen Sie die Nachricht

 @ 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. Starten Sie den Server mit HTTPS

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

Absenderapis

Es gibt verschiedene Arten von Nachrichten: text , image , quick replies , button template oder generic template . API bietet verschiedene Klassen, um die Nachrichtenvorlage zu generieren.

Senden eines Textes und Bildes

Senden Sie einen einfachen Text oder ein Bild an einen Empfänger. Stellen Sie einfach sicher, dass die Bild -URL ein gültiger Link ist.

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

Schnelle Antworten

Die Klasse QuickReply(title, payload, image_url, content_type) definiert eine vorliegende Schaltfläche für den Benutzer als Antwort auf eine Nachricht.

Parameter	Beschreibung	Erforderlich
title	Der Button -Titel	Y
payload	Die Klick -Nutzlastzeichenfolge klicken	Y
image_url	Die Icon -Bild -URL	N
content_type	TEXT oder LOCATION	Y

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

Schaltfläche Vorlage

Die ActionButton(button_type, title, url, payload) definiert die Schaltfläche Vorlage, die einen Text- und Schaltflächen -Anhang enthält, um Eingaben vom Benutzer anzufordern.

Parameter	Beschreibung	Erforderlich
button_type	WEB_URL oder POSTBACK	Y
title	Der Button -Titel	Y
url	Der Link	Nur wenn button_type url ist
payload	Die Klick -Nutzlastzeichenfolge klicken	Nur wenn button_type POSTBACK ist

 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 )
])

Generische Vorlage

Die GenericElement(title, subtitle, image_url, buttons) definiert eine horizontale karouselbezogene Elemente, die jeweils aus einem Bildanhang, einer kurzen Beschreibung und den Schaltflächen besteht, um Eingaben vom Benutzer anzufordern.

Parameter	Beschreibung	Erforderlich
title_text	Der Haupttitel der Nachricht	Y
subtitle_text	Der Untertitel der Nachricht, lassen Sie es leer, wenn Sie es nicht benötigen	N
button_list	Die Liste der 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 )

Dienstprogramm -APIs

Abonnieren Sie die Seiten

Bevor Ihr Chatbot mit dem Empfangen von Nachrichten beginnt, müssen Sie die Anwendung auf Ihre Chatbot -Seite abonnieren. Um eine Seite zu abonnieren, rufen Sie sie einfach an:

 client . subscribe_to_page ()

Legen Sie die Begrüßungsnachricht und die Taste zum Starten fest

Der Grußtext wird zum ersten Mal angezeigt, als Sie diesen Chatbot nur auf Mobilgeräten öffnen. Die Nutzlast ist der Auslöser, wenn die Benutzer auf die Schaltfläche "Erste Schritte erstellen" klicken.

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

Probleme

Fühlen Sie sich frei, Fehlerberichte oder Feature -Anfragen einzureichen, und stellen Sie sicher, dass Sie die Beitragsrichtlinie lesen, bevor Sie ein Problem eröffnen.

Beitragen

1. Überprüfen Sie die Öffnen / Schließen oder öffnen Sie ein neues Problem für Feature -Anfrage oder Fehlerbericht mit verschiedenen Etiketten ( feature / bug ).
2. Geben Sie dieses Repository auf Github auf, um sich auf Master oder New Zweig anzupassen.
3. Schreiben Sie einen Test, der zeigt, dass die Funktion wie erwartet funktioniert oder der Fehler behoben wurde.
4. Senden Sie eine Pull -Anfrage und warten Sie auf die Codeüberprüfung.

Lesen Sie mehr über den Beitrag.

Lizenz

 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.