PyMessager

PyMessager

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

Vollständige Tutorials finden Sie unter Entwickeln 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. (zu erstellen, falls Sie noch keines haben)
2. Erstellen Sie auf Facebook eine Entwickleranwendung für Entwickler.
3. Starten Sie ein Python-Projekt und installieren Sie die erforderlichen Pakete und Module: Flask, Requests.
4. Verwenden Sie Let's Encrypt, um die SSL-Zertifizierung für Ihren Domainnamen anzuwenden.

Installieren

Um PyMessager zu installieren, führen Sie einfach Folgendes aus:

$ pip install pymessager

oder aus dem Repository installieren:

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

Legen Sie los

Import

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

Initialisierung

Sie können einen Messager-Client über ein Facebook-Zugriffstoken über die Entwicklerkonsole initialisieren:

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

Empfänger-APIs

Der folgende Code wird zum Erstellen eines Nachrichtenempfängers verwendet. Zur Vorbereitung Ihres Bots sind drei Hauptschritte erforderlich:

1. Richten Sie den 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 )

Absender-APIs

Es gibt verschiedene Arten von Nachrichten: text , image , quick replies , button template oder generic template . Die API stellt verschiedene Klassen zum Generieren der Nachrichtenvorlage bereit.

Senden eines Textes und eines Bildes

Senden Sie einen einfachen Text oder ein Bild an einen Empfänger. Stellen Sie jedoch 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 Schaltfläche, die dem Benutzer als Reaktion auf eine Nachricht angezeigt wird.

Parameter	Beschreibung	Erforderlich
title	Der Schaltflächentitel	Y
payload	Die Klick-Payload-Zeichenfolge	Y
image_url	Die Symbolbild-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ächenvorlage

Die ActionButton(button_type, title, url, payload) -Klasse definiert eine Schaltflächenvorlage, die einen Text- und Schaltflächenanhang enthält, um Eingaben vom Benutzer anzufordern.

Parameter	Beschreibung	Erforderlich
button_type	WEB_URL oder POSTBACK	Y
title	Der Schaltflächentitel	Y
url	Der Link	Nur wenn button_type url ist
payload	Die Klick-Payload-Zeichenfolge	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 Klasse GenericElement(title, subtitle, image_url, buttons) definiert ein horizontal scrollbares Karussell mit Elementen, die jeweils aus einem Bildanhang, einer kurzen Beschreibung und Schaltflächen bestehen, um Eingaben vom Benutzer anzufordern.

Parameter	Beschreibung	Erforderlich
title_text	Der Haupttitel der Nachricht	Y
subtitle_text	Lassen Sie den Untertitel der Nachricht leer, wenn Sie ihn 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 Nachrichten empfängt, müssen Sie die Anwendung auf Ihrer Chatbot-Seite abonnieren. Um eine Seite zu abonnieren, rufen Sie sie einfach auf:

 client . subscribe_to_page ()

Legen Sie die Willkommensnachricht und die Schaltfläche „Erste Schritte“ fest

Der Begrüßungstext wird angezeigt, wenn Sie diesen Chatbot zum ersten Mal auf Mobilgeräten öffnen. Die Nutzlast ist der Auslöser, wenn die Benutzer auf die Schaltfläche „Erste Schritte“ 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 Funktionsanfragen einzureichen und stellen Sie sicher, dass Sie die Beitragsrichtlinie lesen, bevor Sie ein Problem eröffnen.

Mitwirken

1. Überprüfen Sie die geöffneten/geschlossenen Probleme oder öffnen Sie ein neues Problem für Funktionsanfragen oder Fehlerberichte mit unterschiedlichen Bezeichnungen ( feature / bug ).
2. Verzweigen Sie dieses Repository auf GitHub, um mit der Anpassung im Master oder neuen Zweig zu beginnen.
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 Mitwirken.

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.