Skip to main content
Join the official 2019 Python Developers SurveyStart the survey!

A clean Python Wrapper for Facebook Messenger Platform

Project description

Morrison |Build Status|
===========================

Python Wrapper for `Facebook Messenger
Platform <https://developers.facebook.com/docs/messenger-platform>`__.

**Disclaimer**: This wrapper is **NOT** an official wrapper and does not
attempt to represent Facebook in anyway.

About
~~~~~

This wrapper has the following functions:

- ``send_text_message(recipient_id, message)``
- ``send_message(recipient_id, message)``
- ``send_generic_message(recipient_id, elements)``
- ``send_button_message(recipient_id, text, buttons)``
- ``send_attachment(recipient_id, attachment_type, attachment_path)``
- ``send_attachment_url(recipient_id, attachment_type, attachment_url)``
- ``send_quick_reply(recipient_id, text, buttons) ``
- ``send_image(recipient_id, image_path)``
- ``send_image_url(recipient_id, image_url)``
- ``send_audio(recipient_id, audio_path)``
- ``send_audio_url(recipient_id, audio_url)``
- ``send_video(recipient_id, video_path)``
- ``send_video_url(recipient_id, video_url)``
- ``send_file(recipient_id, file_path)``
- ``send_file_url(recipient_id, file_url)``
- ``send_action(recipient_id, action)``
- ``send_raw(payload)``
- ``get_user_info(recipient_id)``
- ``send_quick_reply(recipient_id, text, buttons)``

You can see the code/documentation for there in
`bot.py <Morrison/bot.py>`__.

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 <https://developers.facebook.com/apps/>`__, 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 <https://developers.facebook.com/docs/messenger-platform/quickstart>`__

Installation
~~~~~~~~~~~~

.. code:: bash

pip install Morrison
or
pip3 install Morrison

Usage
~~~~~

.. code:: python

from Morrison.bot import Bot

bot = Bot(<access_token>, [optional: app_secret])
bot.send_text_message(recipient_id, message)

**Note**: From Facebook regarding User IDs

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 <https://developers.facebook.com/docs/graph-api/securing-requests#appsecret_proof>`__

Sending a generic template message:
'''''''''''''''''''''''''''''''''''

`Generic Template
Messages <https://developers.facebook.com/docs/messenger-platform/implementation#receive_message>`__
allows you to add cool elements like images, text all in a single
bubble.

.. code:: python

from Morrison.bot import Bot
from Morrison import Element
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:

.. figure:: https://cloud.githubusercontent.com/assets/68039/14519266/4c7033b2-0250-11e6-81a3-f85f3809d86c.png
:alt: Generic Bot Output

Generic Bot Output

Sending an image/video/file using an URL:
'''''''''''''''''''''''''''''''''''''''''

.. code:: python

from Morrison.bot import Bot
bot = Bot(<access_token>)
image_url = "http://url/to/image.png"
bot.send_image_url(recipient_id, image_url)

Todo
~~~~

- Structured Messages
- Receipt Messages
- Quick Replies
- Airlines
- Tests!

Example
~~~~~~~

.. figure:: https://cloud.githubusercontent.com/assets/68039/14516627/905c84ae-0237-11e6-918e-2c2ae9352f7d.png
:alt: Screenshot of Echo Facebook Bot

Screenshot of Echo Facebook Bot

You can find an example of an Echo Facebook Bot in ``examples/``

.. |Build Status| image:: https://travis-ci.org/thecolumbialion/Morrison.svg?branch=master
:target: https://travis-ci.org/thecolumbialion/Morrison

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Morrison, version 0.9.51
Filename, size File type Python version Upload date Hashes
Filename, size Morrison-0.9.51.tar.gz (7.3 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page