forked from ookamiiixd/baileys-api
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added postman collection and readme file
- Loading branch information
1 parent
b8fe206
commit 6f649bb
Showing
2 changed files
with
1,411 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# Baileys API | ||
|
||
An implementation of [@adiwajshing/Baileys](https://github.com/adiwajshing/Baileys) as a simple RESTful API service with multiple device support. | ||
|
||
## Installation | ||
|
||
1. Download or clone this repo. | ||
2. Enter to the project directory. | ||
3. Execute `npm i` to install the dependencies. | ||
|
||
## Usage | ||
|
||
1. You can start the app by executing `npm run start` or `node .`. | ||
2. Now the endpoint should be available according to your environment variable settings. Default is at `http://localhost:8000`. | ||
|
||
## API Docs | ||
|
||
The API documentation is available online at [here](https://documenter.getpostman.com/view/18988925/UVRHiNne). You can also import the **Postman Collection File** `(postman_collection.json)` into your Postman App alternatively. | ||
|
||
The server will respond in JSON format: | ||
|
||
```javascript | ||
{ | ||
success: true|false, // bool | ||
message: "", // string | ||
data: {} // object | ||
} | ||
``` | ||
|
||
## Notice | ||
|
||
This project is intended for learning purpose only, don't use this for spam or any activities that is prohibited by **WhatsApp**. |
Oops, something went wrong.