A python library to communicate with the Facebook Messenger API's
- Installation
- Example usage with Flask
- Elements
- Attachments
- Templates
- Sender Actions
- Quick Replies
- Thread settings
Install from pip
pip install fbmessenger- Create a page for your app, if you don't already have one
- Create an app
- Add the Messenger product
- Select the Page to generate a page token
First you need to create a verify token, this can be any string e.g.
'my_verify_token'
We need to extend the BaseMessenger abstract class and implement methods for each of the following subscription fields.
messagedeliveryreadoptinpostbackaccount_linking
from fbmessenger import BaseMessenger
class Messenger(BaseMessenger):
def __init__(self, page_access_token):
self.page_access_token = page_access_token
super(Messenger, self).__init__(self.page_access_token)
def message(self, message):
self.send({'text': 'Received: {0}'.format(message['message']['text'])})
def delivery(self, message):
pass
def read(self, message):
pass
def account_linking(self, message):
pass
def postback(self, message):
pass
def optin(self, message):
passThis can be used to process any messages received and also to verify your app
import os
from flask import Flask, request
app = Flask(__name__)
app.debug = True
messenger = Messenger(os.environ.get('FB_VERIFY_TOKEN'), os.environ.get('FB_PAGE_TOKEN'))
@app.route('/webhook', methods=['GET', 'POST'])
def webhook():
if request.method == 'GET':
if (request.args.get('hub.verify_token') == os.environ.get('FB_VERIFY_TOKEN')):
return request.args.get('hub.challenge')
raise ValueError('FB_VERIFY_TOKEN does not match.')
elif request.method == 'POST':
messenger.handle(request.get_json(force=True))
return ''
if __name__ == "__main__":
app.run(host='0.0.0.0')Import the elements (or just the ones you need)
from fbmessenger import elements
You can pass a simple dict or use the Class
messenger.send({'text': msg})
elem = elements.Text('Your Message')
messenger.send(elem.to_dict())btn = elements.Button(title='Web button', url='http://example.com')
messenger.send(btn.to_dict())To use these buttons you must have the message_deliveries subscription enabled
btn = elements.Button(title='Postback button', payload='payload')
messenger.send(btn.to_dict())image = attachments.Image(url='http://example.com/image.jpg')
messenger.send(image.to_dict())audio = attachments.Image(url='http://example.com/audio.mp3')
messenger.send(audio.to_dict())video = attachments.Video(url='http://example.com/video.mp4')
messenger.send(video.to_dict())file = attachments.File(url='http://example.com/file.txt')
messenger.send(file.to_dict())Import the templates (or just the ones you need)
from fbmessenger import templates
btn = elements.Button(title='Web button', url='http://facebook.com')
elems = elements.Element(
title='Element',
item_url='http://facebook.com',
image_url='http://facebook.com/image.jpg',
subtitle='Subtitle',
buttons=[
btn
]
)
res = templates.GenericTemplate(elements=[elems])
messenger.send(res.to_dict())btn = elements.Button(title='Web button', url='http://facebook.com')
btn2 = elements.Button(title='Postback button', payload='payload')
res = templates.ButtonTemplate(
text='Button template',
buttons=[btn, btn2]
)
messenger.send(res.to_dict())element = elements.Element(
title='Classic White T-Shirt',
subtitle='100% Soft and Luxurious Cotton',
quantity=2,
price=50,
currency='USD',
image_url='http://petersapparel.parseapp.com/img/whiteshirt.png',
)
adjustment1 = elements.Adjustment(name='New Customer Discount', amount=20)
adjustment2 = elements.Adjustment(name='$10 Off Coupon', amount=10)
address = elements.Address(
street_1='1 Hacker Way',
city='Menlo Park',
postal_code='94025',
state='CA',
country='US'
)
summary = elements.Summary(
subtotal=75.00,
shipping_cost=4.95,
total_tax=6.19,
total_cost=56.14
)
res = templates.ReceiptTemplate(
recipient_name='Stephane Crozatier',
order_number='12345678902',
currency='USD',
payment_method='Visa 2345',
order_url='http://petersapparel.parseapp.com/order?order_id=123456',
timestamp='1428444852',
address=address,
summary=summary,
adjustments=[adjustment1, adjustment2],
elements=[element]
)
messenger.send(res.to_dict())typing_on = SenderAction(sender_action='typing_on')
messenger.send_action(typing_on.to_dict())typing_ffn = SenderAction(sender_action='typing_off')
messenger.send_action(typing_off.to_dict())mark_seen = SenderAction(sender_action='mark_seen')
messenger.send_action(mark_seen.to_dict())quick_reply_1 = QuickReply(title='Do something', payload='Send me this payload')
quick_reply_2 = QuickReply(title='Do something else', payload='Send me this other payload')
quick_replies = QuickReplies(quick_replies=[
quick_reply_1,
quick_reply_2
])
text = { text: 'A message' }
text['quick_replies'] = quick_replies.to_dict()
messenger.send(text)from fbmessenger.thread_settings import GreetingText, MessengerProfile
greeting_text = GreetingText('Welcome to my bot')
messenger_profile = MessengerProfile(greetings=[greeting_text])
messenger.set_messenger_profile(messenger_profile.to_dict())from fbmessenger.thread_settings import GetStartedButton, MessengerProfile
get_started = GetStartedButton(payload='GET_STARTED')
messenger_profile = MessengerProfile(get_started=get_started)
messenger.set_messenger_profile(messenger_profile.to_dict())You can then check for this payload in the postback method
from fbmessenger.thread_settings import PersistentMenu, PersistentMenuItem, MessengerProfile
menu_item_1 = PersistentMenuItem(item_type='web_url', title='Menu Item 1', url='https://facebook.com')
menu_item_2 = PersistentMenuItem(item_type='postback', title='Menu Item 2', payload='PAYLOAD')
menu = PersistentMenu(menu_items=[menu_item_1, menu_item_2])
messenger_profile = MessengerProfile(persistent_menus=[menu])
messenger.set_messenger_profile(messenger_profile.to_dict())