Python Wrapper for Facebook Send/Receive API
Wrapper for Facebook's Messenger Platform.
Disclaimer: This wrapper is NOT an official wrapper and do not attempt to represent Facebook in anyway.
About
This wrapper has the following functions:
- send_text_message(recipient_id, message)
The functions return the full JSON body of the actual API call to Facebook.
Register for an Access Token
You'll need to setup a Facebook App, Facebook Page, get the Page Access Token and link the App to the Page before you can really start to use the Send/Receive service.
This quickstart guide should help
Installation
$ pip install pymessenger
Usage
from pymessenger.bot import Bot
bot = Bot(<access_token>, <optional: app_secret>)
bot.send_text_message(recipient_id, message)
Note: From Facebook
These ids are page-scoped. These ids differ from those returned from Facebook Login apps which are app-scoped. You must use ids retrieved from a Messenger integration for this page in order to function properly.
If
app_secret
is initialized, an app_secret_proof will be generated and send with every request. Appsecret Proofs helps further secure your client access tokens. You can find out more on the Facebook Docs
Sending a generic template message:
Generic Template Messages allows you to add cool elements like images, text all in a single bubble.
from pymessenger.bot import Bot
bot = Bot(<access_token>)
elements = []
element = Element(title="test", image_url="<arsenal_logo.png>", subtitle="subtitle", item_url="http://arsenal.com")
elements.append(element)
bot.send_generic_message(recipient_id, elements)
Output:
Sending an image using an URL:
from pymessenger.bot import Bot
bot = Bot(<access_token>)
image_url = "http://url/to/image.png"
bot.send_image_url(recipient_id, image_url)
Note: Images must be in JPG/PNG format only.
Todo
- Structured Messages
- Receipt Messages
- Tests!
Example
You can find an example of an Echo Facebook Bot in examples/