Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neurotech-hq/sarufi-messenger-blueprint
Starter code to integrating sarufi chatbot with Facebook messenger
https://github.com/neurotech-hq/sarufi-messenger-blueprint
messenger-chatbot messenger-chatbots sarufi sarufi-bots
Last synced: about 1 month ago
JSON representation
Starter code to integrating sarufi chatbot with Facebook messenger
- Host: GitHub
- URL: https://github.com/neurotech-hq/sarufi-messenger-blueprint
- Owner: Neurotech-HQ
- License: mit
- Created: 2023-04-17T16:54:27.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-05-09T11:34:17.000Z (8 months ago)
- Last Synced: 2024-05-10T11:56:06.378Z (8 months ago)
- Topics: messenger-chatbot, messenger-chatbots, sarufi, sarufi-bots
- Language: Python
- Homepage:
- Size: 1.42 MB
- Stars: 2
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sarufi messenger blueprint
A starter code to integrate sarufi chatbot with Facebook messenger. In the blueprint, we need to set up a webhook to receive new messages. This can be done in many ways but we shall use two ways namely [ngrok](#using-ngrok) and [replit](#using-replit).
## Messenger set-up
To get started using this blueprint, you will need credentials which you can get from [Facebook Developer Portal](https://developers.facebook.com/) after creating an app. Note that the bot will be used on a page so you will need to create a page.
Here are steps to follow for you to get started:
- [Go to your apps](https://developers.facebook.com/apps)
- [create an app](https://developers.facebook.com/apps/create/)
- On `Which use case do you want to add to your app?`, select **Other** >> Next
- Select Business >> Business
- It will prompt you to enter basic app informations
- It will ask you to add products to your app. Add Messenger
- Create a page if you have none as the bot will be used on the page
- Get `access token`.
## Deloying the bot
### Using ngrok
Steps
1. Make sure you have [ngrok](https://ngrok.com) installed in your machine.
2. Make Project folder.
Lets Make a project folder named `messenger-bot`. Navigate into it to create virtual evironment `messsenger-bot-env`. Activate the environment.
Run the command to make the magic happen
```bash
mkdir messenger-bot
cd messenger-bot
python3 -m venv messenger-bot-env
source messenger-bot-env/bin/activate
```
3. Clone the repo
```bash
git clone https://github.com/Neurotech-HQ/sarufi-messenger-blueprint.git
```
4. Install requirements.
Make sure you are in activated environment, then run the following
```bash
cd sarufi-messenger-blueprint
pip3 install -r requiremnts.txt
```
5. Create .env file
We are going to keep our credentials in `.env` file. You can use either a text editor or command line to creat it. With messenger page access token, we covered it previously. Then for sarufi api key, just follow this to [get sarufi credentials](#getting-sarufi-credentials)
In the file, we are going to add the following
```bash
SARUFI_API_KEY=Your sarufi API key
PAGE_ACCESS_TOKEN = Your facebook page token
SARUFI_BOT_ID= Id of bot to be deployed
VERIFY_TOKEN = A random string to be used as verification token
```
You can add optional variable `PORT` to specify the port number to be used. If you don't specify it, the default port number, *8000* will be used.
A `VERIFY TOKEN` is a random string that you will use to verify that the request is coming from Facebook. You can use any random string, but make sure you keep it because you will need to use the same string when we are setting up the webhook.
6. Run main.py and set ngrok
- Fire up your python script
```bash
python3 main.py
```
- Start ngrok
```bash
./ngrok http 8000
```
**`Note:`** Keep the port number the same as used in `main.py`.
7. Setting webhook
After starting ngrok, you will have a public url to access the local server. The url looks like `https://xxxxxxxxxxx.ngrok.io`. Navigate into your facebook developer account. On the webhooks section, click `messenger` >> `settings`.
Scroll down to webhook section of messenger, click `Add callback url`. Then paste the provided url into url section. Copy the `VERIFY_TOKEN`, paste it into verify token in messenger >> **Verify and save**.
8. webhook field subscription
We have to subscribe to webhook fields in order to receive messages sent by user. We shall subscribe to `messages` and `messaging_postback` topic.
9. Test your bot
Open your messenger app/web, search for your page name. Send messages to it. The messages will be redirected to your bot. Here is the sample of our pizza bot deployed.
### Using replit
Way to go
- Log into your [Replit](https://replit.com/) account.
Fork the repo [Sarufi bot deployed on messenger](https://replit.com/@neurotechafrica/sarufi-messenger-blueprint) into your account.
Navigate to `Tools`--> `Secrets` to create environment variables. We have discussed on how to get page access token at introduction part where as for sarufi view instructions here [get sarufi credentials](#getting-sarufi-credentials).
Create
|Key | Description|
|:---|:---|
|SARUFI_API_KEY| Your sarufi API key|
|PAGE_ACCESS_TOKEN| Your facebook page token|
|SARUFI_BOT_ID| Id of bot to be deployed|
|VERIFY_TOKEN| A random string to be used as verification token|
A `VERIFY TOKEN` is a random string that you will use to verify that the request is coming from Facebook. You can use any random string, but make sure you keep track of it because you will need to use the same string when we are setting up the webhook.
- Run the script
After creating the secret keys, run your `main.py`. A small webview window will open up with a url that looks like `https://{your repl name}.{your replit username}.repl.co`.
With the url, Navigate into your facebook developer account. On the webhooks section, click `messenger` >> `settings`.
Scroll down to webhook section of messenger, click `Add callback url`. Then paste the provided url into url section. Copy the `VERIFY_TOKEN`, paste it into verify token in messenger >> **Verify and save**.
- Webhook field subscription
We have to subscribe to webhook fields in order to receive messages sent by user. We shall subscribe to `messages` and `messaging_postback` topic.
- Final touches
We are reaching at a good point with the set-up. Open your messenger app/web, search for your page name. Send messages to it. The messages will be redirected to your bot. Here is the sample of our pizza bot deployed.
## getting sarufi credentials
To authorize our chabot, we are are going to use authorization keys from sarufi. Log in into your [sarufi account](https://sarufi.io). Go to your Profile to get API key.
## Pizza Bot test
With a bot deployed in messenger, here is a sample of a pizza bot.
## Issues
If you will face any issue, please raise one so as we can fix it as soon as possible.
## Contribution
If there is something you would like to contribute, from typos to code to documentation, feel free to do so, `JUST FORK IT`.
## Credits
All the credits to
1. [kalebu](https://github.com/Kalebu/)
2. [Jovine](https://github.com/jovyinny/)
3. All other contributors