Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jersoncarin/fb-chat-command
Unofficial Facebook Chat API for user-account (not page).
https://github.com/jersoncarin/fb-chat-command
Last synced: about 22 hours ago
JSON representation
Unofficial Facebook Chat API for user-account (not page).
- Host: GitHub
- URL: https://github.com/jersoncarin/fb-chat-command
- Owner: jersoncarin
- Created: 2022-02-01T08:37:45.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-04T17:12:04.000Z (almost 3 years ago)
- Last Synced: 2024-04-25T05:02:59.207Z (7 months ago)
- Language: JavaScript
- Size: 569 KB
- Stars: 5
- Watchers: 1
- Forks: 9
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
This repo is a fork from main repo and will usually have new features bundled faster than main repo (and maybe bundle some bugs, too).
# Facebook Chat Command API
This API is the only way to automate chat functionalities on a user account. We do this by emulating the browser. This means doing the exact same GET/POST requests and tricking Facebook into thinking we're accessing the website normally. Because we're doing it this way, this API won't work with an auth token but requires the credentials of a Facebook account.
## Install
```bash
npm install fb-chat-command
```
## Testing your bots
If you want to test your bots without creating another account on Facebook, you can use [Facebook Whitehat Accounts](https://www.facebook.com/whitehat/accounts/).
## Authenticate
To authenticate your account you should create .env or export it on Environment variable
```bash
[email protected]
FB_PASS=markzuckerbot
# Also you can pass selfListen and listentEvent here
LISTEN_EVENT=true
SELF_LISTEN=true
```
Now you can run npm command to authenticate it.
```bash
npm authenticate
```
## Example Usage
```javascript
const command = require("fb-chat-command");
// Initialize the chat command first
// you can also pass option example command prefix
command.init({ prefix: '/' });
command.add((body,event,api) => {
console.log(body)
},{ prefix: '/' , command: 'help' })
// also you can get all command registered
command.list()
```
# APIs
* [`api.addUserToGroup`](#addUserToGroup)
* [`api.changeAdminStatus`](#changeAdminStatus)
* [`api.changeArchivedStatus`](#changeArchivedStatus)
* [`api.changeBlockedStatus`](#changeBlockedStatus)
* [`api.changeGroupImage`](#changeGroupImage)
* [`api.changeNickname`](#changeNickname)
* [`api.changeThreadColor`](#changeThreadColor)
* [`api.changeThreadEmoji`](#changeThreadEmoji)
* [`api.createNewGroup`](#createNewGroup)
* [`api.createPoll`](#createPoll)
* [`api.deleteMessage`](#deleteMessage)
* [`api.deleteThread`](#deleteThread)
* [`api.forwardAttachment`](#forwardAttachment)
* [`api.getAppState`](#getAppState)
* [`api.getCurrentUserID`](#getCurrentUserID)
* [`api.getEmojiUrl`](#getEmojiUrl)
* [`api.getFriendsList`](#getFriendsList)
* [`api.getThreadHistory`](#getThreadHistory)
* [`api.getThreadInfo`](#getThreadInfo)
* [`api.getThreadList`](#getThreadList)
* [`api.getThreadPictures`](#getThreadPictures)
* [`api.getUserID`](#getUserID)
* [`api.getUserInfo`](#getUserInfo)
* [`api.handleMessageRequest`](#handleMessageRequest)
* [`api.listen`](#listen)
* [`api.listenMqtt`](#listenMqtt)
* [`api.logout`](#logout)
* [`api.markAsDelivered`](#markAsDelivered)
* [`api.markAsRead`](#markAsRead)
* [`api.markAsReadAll`](#markAsReadAll)
* [`api.markAsSeen`](#markAsSeen)
* [`api.muteThread`](#muteThread)
* [`api.removeUserFromGroup`](#removeUserFromGroup)
* [`api.resolvePhotoUrl`](#resolvePhotoUrl)
* [`api.searchForThread`](#searchForThread)
* [`api.sendMessage`](#sendMessage)
* [`api.sendTypingIndicator`](#sendTypingIndicator)
* [`api.setMessageReaction`](#setMessageReaction)
* [`api.setOptions`](#setOptions)
* [`api.setTitle`](#setTitle)
* [`api.threadColors`](#threadColors)
* [`api.unsendMessage`](#unsendMessage)
---------------------------------------
# Documentation
See [this](https://github.com/Schmavery/facebook-chat-api/blob/master/DOCS.md) from [facebook-chat-api](https://github.com/Schmavery/facebook-chat-api)
# Credits
[facebook-chat-api contributors](https://github.com/Schmavery/facebook-chat-api)
[puppeteer](https://github.com/puppeteer/puppeteer)
# LICENSE
```
The MIT License (MIT)
Copyright (c) 2015 Avery, Benjamin, David, Maude
Copyright (c) 2022 Jerson Carin
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.
```