Skip to main content

A Python SDK and Flask API to develop Facebook Messenger application

Project description

# PyMessager

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![PyPI version](https://badge.fury.io/py/PyMessager.svg)](https://badge.fury.io/py/PyMessager)

PyMessager is a Python API for [Facebook Messenger](https://developers.facebook.com/docs/messenger-platform) and a sample project to demonstrate how to develop a chatbot on Facebook Messenger.

![](https://raw.githubusercontent.com/enginebai/PyMessager/master/art/graphic.png)

Complete tutorials are on [Develop a Facebook Bot Using Python](https://medium.com/@enginebai/%E7%94%A8python%E9%96%8B%E7%99%BCfacebook-bot-26594f13f9f7#.7iwm148ag) and [Chatbot: From 0 To 1](https://medium.com/dualcores-studio/%E8%81%8A%E5%A4%A9%E6%A9%9F%E5%99%A8%E4%BA%BA%E5%85%A5%E9%96%80-%E5%BE%9E0%E5%88%B01-4792b53a1318) where you can find more detailed information to setup and develop.

## Before Starting
1. Prepare a Facebook Page. (to create if you don't have one)
2. Create a developer application on [Facebook for Developers](https://developers.facebook.com).
3. Start a python project, and install the required packages and modules: [Flask](http://flask.pocoo.org), [Requests](http://docs.python-requests.org/en/master/).
4. Use [Let's Encrypt](https://letsencrypt.org/getting-started/) to apply SSL certification for your domain name.

## Install
To install PyMessager, simply run:

```shell
$ pip install pymessager
```

or install from the repository:

```shell
$ git clone git@github.com:enginebai/PyMessager.git
$ cd PyMessager
$ pip install -r requirements.txt
```

## Get Started


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

### Initialization
You can initialize a messager client via a Facebook Access Token from the developer console:

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

## Receiver APIs
The following code is used to build a message receiver, there are three main steps to prepare for your bot:

1. Setup the Webhook

```python
@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. Receive the message

```python
@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. Start the server with https

```python
if __name__ == '__main__':
context = ('ssl/fullchain.pem', 'ssl/privkey.pem')
app.run(host='0.0.0.0', debug=True, ssl_context=context)
```


## Sender APIs
![](https://raw.githubusercontent.com/enginebai/PyMessager/master/art/usage.png)

There are several types of message: `text`, `image`, `quick replies`, `button template` or `generic template`. API provides different classes to generate the message template.

### Sending a text and image
Send a simple text or an image to a recipient, just make sure that image URL is a valid link.

```python
client.send_text(recipient_id, "Hello, I'm enginebai."
client.send_image(recipient_id, "http://image-url.jpg")
```

### Quick Replies
The `QuickReply(title, payload, image_url, content_type)` class defines a present buttons to the user in response to a message.

| Parameter | Description | Required |
| -------------- | ------------------------ | -------- |
| `title` | The button title | Y |
| `payload` | The click payload string | Y |
| `image_url` | The icon image URL | N |
| `content_type` | `TEXT` or `LOCATION` | Y |

```python
client.send_quick_replies(recipient_id, "Help", [
QuickReply("Projects", Intent.PROJECT),
QuickReply("Blog", Intent.BLOG),
QuickReply("Contact Me", Intent.CONTACT_ME)
])
```

### Button Template
The `ActionButton(button_type, title, url, payload)` class defines button template which contains a text and buttons attachment to request input from the user.

| Parameter | Description | Required |
| ------------- | ------------------------ | ----------------------------------- |
| `button_type` | `WEB_URL` or `POSTBACK` | Y |
| `title` | The button title | Y |
| `url` | The link | Only if `button_type` is `url` |
| `payload` | The click payload string | Only if `button_type` is `POSTBACK` |

```python
client.send_buttons(recipient_id, "You can find me with below", [
ActionButton(ButtonType.WEB_URL, "Blog", "http://blog.enginebai.com"),
ActionButton(ButtonType.POSTBACK, "Email", Intent.EMAIL)
])
```
### Generic Template
The `GenericElement(title, subtitle, image_url, buttons)` class defines a horizontal scrollable carousel of items, each composed of an image attachment, short description and buttons to request input from the user.

| Parameter | Description | Required |
| --------------- | ---------------------------------------- | -------- |
| `title_text` | The message main title | Y |
| `subtitle_text` | The message subtitle, leave it empty if you don't need it | N |
| `button_list` | The list of `ActionButton` | Y |


```python
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(recipient_id, project_list)
```

## Utility APIs

### Subscribe the pages
Before your chatbot starts to receive messages, you have to subscribe the application to your chatbot page. To subscribe a page, just call it:

```python
client.subscribe_to_page()
```

### Set the welcome message and get-started button
![](https://raw.githubusercontent.com/enginebai/PyMessager/master/art/onboarding.png)

The greeting text will show at the first time you open this chatbot on mobile only. The payload is the trigger when the users click "Get Started" button.

```python
client.set_greeting_text("Hi, this is Engine Bai. Nice to meet you!")
client.set_get_started_button_payload("HELP") # Specify a payload string.
```

## Issues
Feel free to submit bug reports or feature requests and make sure you read the contribution guideline before opening any issue.


## Contributing
1. Check the open/close issues or open a fresh issue for feature request or bug report with different labels (`feature`/`bug`).
2. Fork this [repository](https://github.com/enginebai/PyMessager) on GitHub to start customizing on master or new branch.
3. Write a test which shows that the feature works as expected or the bug was fixed.
4. Send a pull request and wait for code review.

[Read more on contributing](./CONTRIBUTING.md).

## License

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.

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 PyMessager, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size PyMessager-1.0.1.tar.gz (7.0 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 DigiCert DigiCert EV certificate StatusPage StatusPage Status page