Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/casperlaitw/laravel-fb-messenger
Laravel Facebook Messenger Provider
https://github.com/casperlaitw/laravel-fb-messenger
facebook-messenger-bot laravel messenger-bot messenger-platform
Last synced: 4 days ago
JSON representation
Laravel Facebook Messenger Provider
- Host: GitHub
- URL: https://github.com/casperlaitw/laravel-fb-messenger
- Owner: CasperLaiTW
- License: mit
- Created: 2016-08-30T18:55:40.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-27T02:42:32.000Z (about 3 years ago)
- Last Synced: 2025-01-12T06:07:03.079Z (13 days ago)
- Topics: facebook-messenger-bot, laravel, messenger-bot, messenger-platform
- Language: PHP
- Homepage:
- Size: 2.1 MB
- Stars: 105
- Watchers: 9
- Forks: 27
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Laravel Facebook Messenger Provider
[](https://travis-ci.org/CasperLaiTW/laravel-fb-messenger)
[](https://coveralls.io/github/CasperLaiTW/laravel-fb-messenger)
[](https://styleci.io/repos/66968888)
[](https://packagist.org/packages/casperlaitw/laravel-fb-messenger)
[](https://packagist.org/packages/casperlaitw/laravel-fb-messenger)
[](https://packagist.org/packages/casperlaitw/laravel-fb-messenger)
[](https://packagist.org/packages/casperlaitw/laravel-fb-messenger)
This is a laravel package for Facebook Messenger Platform API.
Easy to making your facebook messenger chatbot.
## Installation
### Composer
```shell
composer require casperlaitw/laravel-fb-messenger
```
## Laravel
### Add Provider
In your `config/app.php` add `Casperlaitw\LaravelFbMessenger\LaravelFbMessengerServiceProvider::class` to the providers array:
```php
'providers' => [
...
Casperlaitw\LaravelFbMessenger\LaravelFbMessengerServiceProvider::class,
...
],
'alias => [
...
'Menu' => Casperlaitw\LaravelFbMessenger\Facades\MessengerMenu::class,
...
],
```
### Publish Configuration
```shell
php artisan vendor:publish --provider="Casperlaitw\LaravelFbMessenger\LaravelFbMessengerServiceProvider" --tag="config"
```
### Publish Menu Configure
Support define persistent menu in file.
Define persistent menu like laravel routes.
[document](https://github.com/CasperLaiTW/laravel-fb-messenger/wiki/Commands#fbmenus)
```shell
php artisan vendor:publish --provider="Casperlaitw\LaravelFbMessenger\LaravelFbMessengerServiceProvider" --tag="menu"
```
## Configuration
### Security
Almost every API request with `access_token`, if you want to improved security in your app,
you can use `appsecret_proof`. Please add `MESSENGER_APP_SECRET` to `.env` file and enable proof on all calls.
*If you don't know how to get secret token and enabled proof, please checkout [Graph Api](https://developers.facebook.com/docs/graph-api/securing-requests)*
`.env`
```
MESSENGER_APP_SECRET="APP SECRET TOKEN"
```
### Token
Add you token to `.env` file or modify `fb-messenger.php` config.
*If you don't know how to get token, please checkout [Facebook Developer](https://developers.facebook.com/docs/messenger-platform/quickstart)*
`.env`
```
...
MESSENGER_VERIFY_TOKEN="By You Writing"
MESSENGER_APP_TOKEN="Page Access Token"
...
```
### Custom Url
If you want to custom url, replace `/webhook` to you want.
Finally, you can run `php artisan route:list` to check.
```php
return [
'verify_token' => env('MESSENGER_VERIFY_TOKEN'),
'app_token' => env('MESSENGER_APP_TOKEN'),
'auto_typing' => true,
'handlers' => [App\DefaultHandler::class],
'custom_url' => '/chatbot', // like this
'postbacks' => [],
];
```
### Custom Handler
The `DefaultHandler` will reply the same words to user.
You can check out [DefaultHandler](https://github.com/CasperLaiTW/laravel-fb-messenger/blob/master/src/Contracts/DefaultHandler.php)
Handler **MUST BE** extends `BaseHandler`.
```php
send(new Text($message->getSender(), "Default Handler: {$message->getMessage()}"));
}
}
```
## Postback Handler
### Create your postback handler
`$payload` is you setting that [fb:get-start](https://github.com/CasperLaiTW/laravel-fb-messenger/wiki/Commands#fbget-start) command or [button message's postback button](https://github.com/CasperLaiTW/laravel-fb-messenger/wiki/Example#button-message) etc.
`$payload` support regex or string.
```php
send(new Text($message->getSender(), "I got your payload"));
}
}
```
### Add to `fb-messenger.php` config
```php
return [
'verify_token' => env('MESSENGER_VERIFY_TOKEN'),
'app_token' => env('MESSENGER_APP_TOKEN'),
'auto_typing' => true,
'handlers' => [App\YourHandler::class],
'postbacks' => [
App\StartupPostback::class,
],
];
```
[Example](https://github.com/CasperLaiTW/laravel-fb-messenger/wiki/Example#postback-handler)
## Debug Route
The debug route using [Pusher](https://pusher.com/)
### Install pusher
Please follow [Laravel Broadcasting](https://laravel.com/docs/5.5/broadcasting#driver-prerequisites) document to install pusher package.
### Configure your `.env`
```
APP_DEBUG=true
BROADCAST_DRIVER=pusher
PUSHER_APP_ID=
PUSHER_APP_KEY=
PUSHER_APP_SECRET=
```
### Publish script
**If package updated, you need to run this script again. Keep your javascript is up-to-date**
```shell
php artisan vendor:publish --provider="Casperlaitw\LaravelFbMessenger\LaravelFbMessengerServiceProvider" --tag="public" --force
```
### Open browser
```url
http://[your-site]/fb-messenger/debug
```
## API
[API Document](https://casperlaitw.github.io/laravel-fb-messenger/)
## Commands
See the [document](https://github.com/CasperLaiTW/laravel-fb-messenger/wiki/Commands)
## License
This package is licensed under the [MIT license](https://github.com/CasperLaiTW/laravel-fb-messenger/blob/master/LICENSE.md).