This code is an implementation of WhiskeySockets, as a RestFull Api service, which controls whatsapp functions.
With this one you can create multiservice chats, service bots or any other system that uses whatsapp. With this code you don't need to know javascript for nodejs , just start the server and make the language requests that you feel most comfortable with.
- First, let's install Docker. Docker is a platform that allows us to quickly create, test and deploy applications in isolated environments called containers.
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
sudo usermod -aG docker ${USER}PostgreSql [required]
- Now, we have configured our PostgreSQL database using Docker Compose.
- Access your postgre manager and create a database.
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
# or
wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bashAfter finishing, restart the terminal to load the new information.
- Installing Node.js using NVM, a version manager that allows us to switch between different versions of Node.js easily.
nvm install 20npm i -g pm2Cloning the Repository
git clone https://github.com/code-chat-br/whatsapp-api.git
Go to the project directory and install all dependencies.
Give preference to npm as it has greater compatibility.
cd whatsapp-api-v2
npm install
# or
npm install --forceSee additional settings that can be applied through the env file by clicking here.
⚠️ Attention⚠️ : copy the .env.dev file to .env.
cp .env.dev .env- We're going to use Prisma ORM to manage our database. Prisma simplifies database access and ensures operations are secure and easy to maintain.
- Commands and Explanations:
- In development environment: npx prisma migrate dev
- We use
migrate devin development to automatically create and apply migrations, making working with the database easier.
- We use
- In production environment: npx prisma migrate deploy
- In production, we use
migrate deployto apply migrations in a controlled and secure way.
- In production, we use
- Data visualization:
npx prisma studio- Prisma Studio is a visual tool that helps us manage and visualize bank data in an intuitive way.
- In development environment: npx prisma migrate dev
Define the DATABASE_URL environment variable for the database deployment.
- Performing the database deployment.
bash deploy_db.shFinally, run the command below to start the application:
npm run start:dev
npm run start:prod
# pm2
pm2 start 'npm run start:prod' --name CodeChat_API_v1.3.0To use the worker with the API it is necessary to define the following environment variables in the API:
PROVIDER_ENABLED=true: This variable enables the use of the provider (worker) in the API.PROVIDER_HOST=127.0.0.1: Defines the host where the worker is listening for requests.PROVIDER_PORT=5656: Defines the port where the worker is listening for requests.PROVIDER_PREFIX=codechat: Set prefix for instance grouping on worker
websocket compatibility added. Read here.
- Route:
http://localhost:8084/docs - YAML file: swagger.yaml
You can define two authentication types for the routes in the env file. Authentications must be inserted in the request header.
- jwt: A JWT is a standard for authentication and information exchange defined with a signature.
Authentications are generated at instance creation time.
Note: There is also the possibility to define a global api key, which can access and control all instances.
After building the application, in the same directory as the files above, run the following command:
docker-compose up| Send Text | ✔ |
| Send Buttons | ❌ |
| Send Template | ❌ |
| Send Media: audio - video - image - document - gif base64: true |
✔ |
| Send Media File | ✔ |
| Send Audio type WhatsApp | ✔ |
| Send Audio type WhatsApp - File | ✔ |
| Send Location | ✔ |
| Send List | ❌ |
| Send Link Preview | ❌ |
| Send Contact | ✔ |
| Send Reaction - emoji | ✔ |
| Name | Event | TypeData | Description |
|---|---|---|---|
| QRCODE_UPDATED | qrcode.updated | json | Sends the base64 of the qrcode for reading |
| CONNECTION_UPDATE | connection.update | json | Informs the status of the connection with whatsapp |
| MESSAGES_SET | message.set | json | Sends a list of all your messages uploaded on whatsapp This event occurs only once |
| MESSAGES_UPSERT | message.upsert | json | Notifies you when a message is received |
| MESSAGES_UPDATE | message.update | json | Tells you when a message is updated |
| SEND_MESSAGE | send.message | json | Notifies when a message is sent |
| CONTACTS_SET | contacts.set | json | Performs initial loading of all contacts This event occurs only once |
| CONTACTS_UPSERT | contacts.upsert | json | Reloads all contacts with additional information This event occurs only once |
| CONTACTS_UPDATE | contacts.update | json | Informs you when the chat is updated |
| PRESENCE_UPDATE | presence.update | json | Informs if the user is online, if he is performing some action like writing or recording and his last seen 'unavailable' |
| CHATS_SET | chats.set | json | Send a list of all loaded chats |
| CHATS_UPDATE | chats.update | json | Informs you when the chat is updated |
| CHATS_UPSERT | chats.upsert | json | Sends any new chat information |
| GROUPS_UPSERT | groups.upsert | JSON | Notifies when a group is created |
| GROUPS_UPDATE | groups.update | JSON | Notifies when a group has its information updated |
| GROUP_PARTICIPANTS_UPDATE | group-participants.update | JSON | Notifies when an action occurs involving a participant 'add' |
| NEW_TOKEN | new.jwt | JSON | Notifies when the token (jwt) is updated |
To install the SSL certificate, follow the instructions below.
This code is in no way affiliated with WhatsApp. Use at your own discretion. Don't spam this.
This code was produced based on the baileys library and it is still under development.
