Unduh fbmq - unduh kode sumber fbmq

(Proyek Tidak Digunakan Lagi)

FBMQ (Perpustakaan Python Platform Facebook Messenger)

Perpustakaan Python Untuk Menggunakan API Platform Facebook Messenger (Perpustakaan Obrolan Facebook Python & Chatbot) Fitur lengkap api platform messenger Facebook didukung

Daftar isi

Memasang
Tangani webhook
- penggunaan (dengan labu)
- penangan
Kirim pesan
- dasar
  - teks
  - gambar / audio / video / file
  - balasan cepat
    - panggilan balasan cepat
  - mengetik aktif/nonaktif
- templat
  - tombol
    - tombol panggilan balik
  - umum
  - kuitansi
- pilihan
  - jenis pemberitahuan
  - panggilan balik
Pengaturan benang
- teks salam
- tombol memulai
- menu persisten
Ambil profil pengguna/halaman
Contoh

Memasang

 pip install fbmq

Tangani webhook

cara menangani pesan dari pengguna ke halaman facebook

Penggunaan (dengan labu)

 from flask import Flask , request
from fbmq import Page

page = Page ( PAGE_ACCESS_TOKEN )

@ app . route ( '/webhook' , methods = [ 'POST' ])
def webhook ():
  page . handle_webhook ( request . get_data ( as_text = True ))
  return "ok"

@ page . handle_message
def message_handler ( event ):
  """:type event: fbmq.Event"""
  sender_id = event . sender_id
  message = event . message_text
  
  page . send ( sender_id , "thank you! your message is '%s'" % message )

@ page . after_send
def after_send ( payload , response ):
  """:type payload: fbmq.Payload"""
  print ( "complete" )

penangan

Spesifikasi secara detail - https://developers.facebook.com/docs/messenger-platform/webhook-reference

@page.handle_message - Panggilan balik ini akan terjadi ketika pesan telah dikirim ke halaman Anda. ( quick reply juga ditangani di sini)

@page.handle_echo - Callback ini akan terjadi ketika pesan telah dikirim oleh halaman Anda

@page.handle_delivery - Panggilan balik ini akan terjadi ketika pesan yang dikirim halaman telah terkirim.

@page.handle_optin - Callback ini akan terjadi ketika plugin Send-to-Messenger telah disadap

@page.handle_postback - Postback terjadi ketika tombol Postback, tombol Memulai, menu Persisten, atau Pesan Terstruktur diketuk.

@page.handle_read - Callback ini akan terjadi ketika pesan yang dikirim halaman telah dibaca oleh pengguna.

@page.handle_account_linking - Callback ini akan terjadi ketika ajakan bertindak Akun Tertaut atau Putuskan Tautan Akun telah disadap.

@page.after_send - Panggilan balik ini akan terjadi ketika fungsi page.send telah dipanggil.

Parameter peristiwa (kelas fbmq.Event)

event.sender_id str : id pengirim pesan, id pengguna

event.recipient_id str : id penerima pesan, id halaman

event.timestamp number : stempel waktu saat pesan diterima

event.message dict : dict pesan yang diterima. lebih detail

event.message_text str : event.message.get('text')

event.message_attachments str : event.message.get('attachments')

event.quick_reply dict : dict balasan cepat yang diterima. lebih detail

event.quick_reply_payload str : `event.quick_reply.get('payload')

event.postback dict : dict postback yang diterima. lebih detail

event.postback_payload str : `acara.postback.get('payload')

event.optin dict : dict yang diterima. lebih detail

event.account_linking dict : dict yang diterima. lebih detail

event.delivery dict : dict yang diterima. lebih detail

event.read dict : dict yang diterima. lebih detail

event.is_* bool - Benar jika jenis acara valid

jika Anda tidak membutuhkan dekorator

 page = fbmq . Page ( PAGE_ACCESS_TOKEN , after_send = after_send )

@ app . route ( '/webhook' , methods = [ 'POST' ])
def webhook ():
  page . handle_webhook ( request . get_data ( as_text = True ),
                      message = message_handler )
  return "ok"

def message_handler ( event ):
  """:type event: fbmq.Event"""
  sender_id = event . sender_id
  message = event . message_text
  
  page . send ( sender_id , "thank you! your message is '%s'" % message )

def after_send ( payload , response ):
  """:type event: fbmq.Payload"""
  print ( "complete" )

Kirim pesan

cara mengirim pesan dari halaman facebook ke pengguna

Dasar

Impor

 from fbmq import Attachment , Template , QuickReply , Page

Teks

 page . send ( recipient_id , "hello world!" )

Gambar

jpg, png, dukungan gif

 page . send ( recipient_id , Attachment . Image ( image_url ))

Audio

 page . send ( recipient_id , Attachment . Audio ( audio_url ))

Video

 page . send ( recipient_id , Attachment . Video ( video_url ))

Mengajukan

 page . send ( recipient_id , Attachment . File ( file_url ))

balasan cepat

 quick_replies = [
  QuickReply ( title = "Action" , payload = "PICK_ACTION" ),
  QuickReply ( title = "Comedy" , payload = "PICK_COMEDY" )
]

# you can use a dict instead of a QuickReply class
#
# quick_replies = [{'title': 'Action', 'payload': 'PICK_ACTION'},
#                {'title': 'Comedy', 'payload': 'PICK_COMEDY'}]


page . send ( recipient_id , 
          "What's your favorite movie genre?" ,
          quick_replies = quick_replies ,
          metadata = "DEVELOPER_DEFINED_METADATA" )

panggilan balasan cepat

Anda dapat dengan mudah menentukan metode panggilan balik balasan cepat.

 @ page . callback ([ 'PICK_ACTION' , 'PICK_COMEDY' ])
def callback_picked_genre ( payload , event ):
  print ( payload , event )
  
# Also supported regex, it works corretly
# @page.callback(['PICK_(.+)'])

jika Anda hanya ingin menangani panggilan balik quick_reply tanpa tombol postback

 @ page . callback ([ 'PICK_ACTION' , 'PICK_COMEDY' ], types = [ 'QUICK_REPLY' ])

mengetik aktif/nonaktif

 page . typing_on ( recipient_id )
page . typing_off ( recipient_id )

Templat

Templat : Tombol

 buttons = [
  Templates . ButtonWeb ( "Open Web URL" , "https://www.oculus.com/en-us/rift/" ),
  Templates . ButtonPostBack ( "trigger Postback" , "DEVELOPED_DEFINED_PAYLOAD" ),
  Templates . ButtonPhoneNumber ( "Call Phone Number" , "+16505551234" )
]

# you can use a dict instead of a Button class
#
# buttons = [{'type': 'web_url', 'title': 'Open Web URL', 'value': 'https://www.oculus.com/en-us/rift/'},
#          {'type': 'postback', 'title': 'trigger Postback', 'value': 'DEVELOPED_DEFINED_PAYLOAD'},
#          {'type': 'phone_number', 'title': 'Call Phone Number', 'value': '+16505551234'}]

page . send ( recipient_id , Template . Buttons ( "hello" , buttons ))

tombol panggilan balik

Anda dapat dengan mudah menentukan metode postback tombol (ini hanya berfungsi pada tombol jenis postback).

 @ page . callback ([ 'DEVELOPED_DEFINED_PAYLOAD' ])
def callback_clicked_button ( payload , event ):
  print ( payload , event )
  
# Also supported regex, it works corretly
# @page.callback(['DEVELOPED_DEFINE(.+)'])

jika Anda hanya ingin menangani postback tombol tanpa panggilan balik quick_reply

 @ page . callback ([ 'DEVELOPED_DEFINED_PAYLOAD' ], types = [ 'POSTBACK' ])

Templat: Generik

 page . send ( recipient_id , Template . Generic ([
  Template . GenericElement ( "rift" ,
                          subtitle = "Next-generation virtual reality" ,
                          item_url = "https://www.oculus.com/en-us/rift/" ,
                          image_url = CONFIG [ 'SERVER_URL' ] + "/assets/rift.png" ,
                          buttons = [
                              Template . ButtonWeb ( "Open Web URL" , "https://www.oculus.com/en-us/rift/" ),
                              Template . ButtonPostBack ( "tigger Postback" , "DEVELOPED_DEFINED_PAYLOAD" ),
                              Template . ButtonPhoneNumber ( "Call Phone Number" , "+16505551234" )
                          ]),
  Template . GenericElement ( "touch" ,
                          subtitle = "Your Hands, Now in VR" ,
                          item_url = "https://www.oculus.com/en-us/touch/" ,
                          image_url = CONFIG [ 'SERVER_URL' ] + "/assets/touch.png" ,
                          buttons = [
                              Template . ButtonWeb ( "Open Web URL" , "https://www.oculus.com/en-us/rift/" ),
                              Template . ButtonPostBack ( "tigger Postback" , "DEVELOPED_DEFINED_PAYLOAD" ),
                              Template . ButtonPhoneNumber ( "Call Phone Number" , "+16505551234" )
                          ])
]))

Templat : Kwitansi

    element = Template . ReceiptElement ( title = "Oculus Rift" ,
                                      subtitle = "Includes: headset, sensor, remote" ,
                                      quantity = 1 ,
                                      price = 599.00 ,
                                      currency = "USD" ,
                                      image_url = CONFIG [ 'SERVER_URL' ] + "/assets/riftsq.png"
                                      )

    address = Template . ReceiptAddress ( street_1 = "1 Hacker Way" ,
                                      street_2 = "" ,
                                      city = "Menlo Park" ,
                                      postal_code = "94025" ,
                                      state = "CA" ,
                                      country = "US" )

    summary = Template . ReceiptSummary ( subtotal = 698.99 ,
                                      shipping_cost = 20.00 ,
                                      total_tax = 57.67 ,
                                      total_cost = 626.66 )

    adjustment = Template . ReceiptAdjustment ( name = "New Customer Discount" , amount = - 50 )

    page . send ( recipient_id , Template . Receipt ( recipient_name = 'Peter Chang' ,
                                            order_number = '1234' ,
                                            currency = 'USD' ,
                                            payment_method = 'Visa 1234' ,
                                            timestamp = "1428444852" ,
                                            elements = [ element ],
                                            address = address ,
                                            summary = summary ,
                                            adjustments = [ adjustment ]))

Pilihan

jenis pemberitahuan

mendukung notifikasi_type sebagai opsi

NotificationType.REGULAR (default) , NotificationType.SILENT_PUSH , NotificationType.NO_PUSH

 page.send(recipient_id, 'hello', notification_type=NotificationType.NO_PUSH)

panggilan balik

Anda dapat mengatur fungsi panggilan balik ke setiap page.send

 def callback(payload, response):
  print('response : ' + response.text)
  
page.send(recipient_id, 'hello', callback=callback)

Pengaturan benang

Teks salam

 page . greeting ( "Welcome!" )

Tombol memulai

 page . show_starting_button ( "START_PAYLOAD" )

@ page . callback ([ 'START_PAYLOAD' ])
def start_callback ( payload , event ):
  print ( "Let's start!" )

Menu yang persisten

 page . show_persistent_menu ([ Template . ButtonPostBack ( 'MENU1' , 'MENU_PAYLOAD/1' ),
                           Template . ButtonPostBack ( 'MENU2' , 'MENU_PAYLOAD/2' )])

@ page . callback ([ 'MENU_PAYLOAD/(.+)' ])
def click_persistent_menu ( payload , event ):
  click_menu = payload . split ( '/' )[ 1 ]
  print ( "you clicked %s menu" % click_menu )

Ambil profil pengguna/halaman

 page_id = page.page_id
page_name = page.page_name
user_profile = page.get_user_profile(event.sender_id) # return dict
print(user_profile)

#{"first_name":"...", "last_name":"...", "profile_pic":"...", "locale":"...", "timezone":9, "gender":"..."}

Contoh

isi example/config.py
menjalankan server

 cd example
virtualenv env
source env/bin/activate
pip install -r requirements.txt
python server.py

Memperluas