https://github.com/bottenderjs/bottender-facebook
Facebook connector for Bottender.
https://github.com/bottenderjs/bottender-facebook
bottender facebook
Last synced: 2 months ago
JSON representation
Facebook connector for Bottender.
- Host: GitHub
- URL: https://github.com/bottenderjs/bottender-facebook
- Owner: bottenderjs
- License: mit
- Created: 2017-11-27T10:52:42.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-01-04T01:20:06.000Z (over 2 years ago)
- Last Synced: 2025-03-26T18:52:40.178Z (3 months ago)
- Topics: bottender, facebook
- Language: JavaScript
- Size: 1.14 MB
- Stars: 9
- Watchers: 4
- Forks: 2
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Bottender Facebook
[](https://www.npmjs.com/package/bottender-facebook)
[](https://travis-ci.org/bottenderjs/bottender-facebook)
[](https://opensource.org/licenses/MIT)
> Facebook connector for [Bottender](https://github.com/Yoctol/bottender).
## Installation
```sh
npm install bottender-facebook bottender messaging-api-messenger
```
## Requirement
### Facebook App Graph API verion
Using the API version before `v2.10` may cause unexpected behavior.\
We highly recommend the API version after `v2.11`.
### Subscribe to essential fields
You need to make sure the webhook of your page is subscribing to the `feed` field on API version after `v2.11`.
### User Permissions Required
- **manage_pages**
- **publish_pages** - for public replies
- **read_page_mailboxes** - for private replies
## Example
```js
const { Bot } = require('bottender');
const { createServer } = require('bottender/express');
const { FacebookConnector } = require('bottender-facebook');
// We can get `story_fbid` in URL query string
const POST_ID =
process.env.POST_ID || `${process.env.PAGE_ID}_${process.env.STORY_FBID}`;
const bot = new Bot({
connector: new FacebookConnector({
accessToken: process.env.ACCESS_TOKEN,
appSecret: process.env.APP_SECRET,
}),
});
bot.onEvent(async context => {
if (
context.event.isCommentAdd &&
context.event.comment.post_id === POST_ID &&
context.event.comment.parent_id === POST_ID
) {
await context.sendPrivateReply('OK!');
await context.sendComment('Public comment!');
}
});
const server = createServer(bot);
```
### Custom Graph API version
The default `Graph API` version is `v3.2` (recommended). \
You can use other version by following this example:
```js
const { Bot } = require('bottender');
const { FacebookConnector, FacebookClient } = require('bottender-facebook');
const bot = new Bot({
connector: new FacebookConnector({
appSecret: APP_SECRET,
client: FacebookClient.connect({
accessToken: ACCESS_TOKEN,
version: '3.2',
}),
}),
});
```
## API Reference
### Client
- `client.sendComment(objectId, comment)`
```js
await client.sendComment('', 'ok!'); // send as text message
await client.sendComment('', { message: 'ok!' });
await client.sendComment('', { attachment_id: '' });
await client.sendComment('', {
attachment_share_url: 'https://example.com/img.gif',
});
await client.sendComment('', {
attachment_url: 'https://example.com/img.jpg',
});
```
- `client.sendPrivateReply(objectId, text)`
```js
await client.sendPrivateReply('', 'ok!');
```
- `client.sendLike()`
- `client.getComment()`
- `client.getLikes()`
### Context
- `context.sendComment(comment)`
```js
await context.sendComment('ok!'); // send as text message
await context.sendComment({ message: 'ok!' });
await context.sendComment({ attachment_id: '' });
await context.sendComment({
attachment_share_url: 'https://example.com/img.gif',
});
await context.sendComment({ attachment_url: 'https://example.com/img.jpg' });
```
- `context.sendPrivateReply(text)`
```js
await context.sendPrivateReply('ok!');
```
- `context.sendLike()`
- `context.getComment()`
```js
const comment = await context.getComment({ fields: ['message_tags'] });
console.log(comment);
// {
// id: '2013582382205928_2258908961006601',
// // facebook returns undefined as message_tags instead of empty array
// // when there is no tag
// message_tags: [
// {
// id: '1895382890692545',
// length: 8,
// name: 'Bot Demo',
// offset: 0,
// type: 'page'
// },
// ],
// }
```
- `context.getLikes()`
- `context.canReplyPrivately()`
```js
await context.canReplyPrivately(); // true
```
### Event
- `event.isFeed`
- `event.isStatus`
- `event.isStatusAdd`
- `event.isStatusEdited`
- `event.status`
- `event.isPost`
- `event.isPostRemove`
- `event.post`
- `event.isComment`
- `event.isCommentAdd`
- `event.isCommentEdited`
- `event.isCommentRemove`
- `event.isFirstLayerComment`
- `event.comment`
- `event.isLike`
- `event.isLikeAdd`
- `event.isLikeRemove`
- `event.like`
- `event.isReaction`
- `event.isReactionAdd`
- `event.isReactionEdit`
- `event.isReactionRemove`
- `event.reaction`
## Contributing
Pull Requests and issue reports are welcome. You can follow steps below to
submit your pull requests:
Fork, then clone the repo:
```sh
git clone [email protected]:your-username/bottender-facebook.git
```
Install the dependencies:
```sh
cd bottender-facebook
yarn
```
Make sure the tests pass (including eslint, flow checks and jest tests):
```sh
yarn test
```
Make your changes and tests, and make sure the tests pass.
## License
MIT © [Yoctol](https://github.com/bottenderjs/bottender-facebook)