Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
abe273166b | ||
|
|
3e37e933b2 | ||
|
|
6d2cae0784 | ||
|
|
0bf44dae88 | ||
|
|
9c9d6fda10 | ||
|
|
8b82f76668 |
No files matched your search
@@ -0,0 +1,5 @@
|
||||
repos:
|
||||
- repo: https://github.com/Lucas-C/pre-commit-hooks-nodejs
|
||||
rev: v1.1.2
|
||||
hooks:
|
||||
- id: markdown-toc
|
||||
@@ -7,6 +7,26 @@ go [through currently supported methods in Swagger](https://allburov.github.io/w
|
||||
|
||||
The project is an HTTP API wrapper around https://github.com/orkestral/venom
|
||||
|
||||
# Tables of Contents
|
||||
|
||||
<!-- toc -->
|
||||
|
||||
- [Installation](#installation)
|
||||
- [First Steps](#first-steps)
|
||||
* [Run WhatsAPP HTTP API](#run-whatsapp-http-api)
|
||||
* [Create a new session and login](#create-a-new-session-and-login)
|
||||
* [Send a text message](#send-a-text-message)
|
||||
- [Receive messages](#receive-messages)
|
||||
+ [Python echo server](#python-echo-server)
|
||||
- [Environment variables](#environment-variables)
|
||||
* [Common](#common)
|
||||
* [Webhooks](#webhooks)
|
||||
* [File storage](#file-storage)
|
||||
- [How to](#how-to)
|
||||
* [How to build the newest Docker image locally](#how-to-build-the-newest-docker-image-locally)
|
||||
- [Support](#support)
|
||||
|
||||
<!-- tocstop -->
|
||||
|
||||
# Installation
|
||||
|
||||
@@ -116,6 +136,7 @@ If you try to send an image the "echo server" will send a path to the downloaded
|
||||
- `DEBUG` - show debug and verbose logs, set in any value
|
||||
- `WHATSAPP_API_PORT` - listen port for HTTP server (default: `3000`)
|
||||
- `WHATSAPP_API_HOSTNAME` - Hostname for HTTP server (default: `localhost`)
|
||||
- `WHATSAPP_START_SESSION` - start session with that name right after launching the app
|
||||
|
||||
## Webhooks
|
||||
|
||||
@@ -137,6 +158,16 @@ All webhooks are disabled by default:
|
||||
like `audio,image`).
|
||||
- `WHATSAPP_FILES_LIFETIME`- to keep free space files will be removed after this time (default: `180`, in seconds)
|
||||
|
||||
# How to
|
||||
## How to build the newest Docker image locally
|
||||
|
||||
If the changes haven't been released yet from `main` branch - you can build your own version from the git repository
|
||||
```bash
|
||||
git clone https://github.com/allburov/whatsapp-http-api.git
|
||||
cd whatsapp-http-api
|
||||
docker build . -t allburov/whatsapp-http-api
|
||||
```
|
||||
|
||||
# Support
|
||||
|
||||
If you want to support the project - you can either:
|
||||
|
||||
@@ -13,6 +13,7 @@
|
||||
"start:dev": "nest start --watch",
|
||||
"start:debug": "nest start --debug --watch",
|
||||
"start:prod": "node --unhandled-rejections=none dist/main",
|
||||
"start:prod-exit": "node dist/main",
|
||||
"lint": "eslint \"{src,apps,libs,test}/**/*.ts\" --fix",
|
||||
"test": "jest",
|
||||
"test:watch": "jest --watch",
|
||||
|
||||
@@ -53,6 +53,12 @@ export class MessageText extends ChatRequest {
|
||||
text: string;
|
||||
}
|
||||
|
||||
export class MessageTextButtons extends ChatRequest {
|
||||
text: string;
|
||||
title: string;
|
||||
buttons: any[];
|
||||
}
|
||||
|
||||
export class MessageReply extends ChatRequest {
|
||||
text: string;
|
||||
@ApiProperty({
|
||||
|
||||
@@ -10,7 +10,8 @@ import {
|
||||
MessageLocation,
|
||||
MessageReply,
|
||||
MessageText,
|
||||
MessageTextQuery
|
||||
MessageTextQuery,
|
||||
MessageTextButtons
|
||||
} from "./all.dto";
|
||||
import {ensureSuffix, WhatsappSessionManager} from "../whatsapp.service";
|
||||
|
||||
@@ -56,6 +57,13 @@ export class ChattingController {
|
||||
return whatsapp.sendText(ensureSuffix(message.chatId), message.text)
|
||||
}
|
||||
|
||||
@Post('/sendTextButtons')
|
||||
@ApiOperation({summary: 'Send a text message with buttons'})
|
||||
sendTextButtons(@Body() message: MessageTextButtons) {
|
||||
const whatsapp = this.whatsappSessionManager.getSession(message.sessionName)
|
||||
return whatsapp.sendButtons(ensureSuffix(message.chatId), message.title, message.buttons, message.text)
|
||||
}
|
||||
|
||||
@Post('/sendLocation')
|
||||
sendLocation(@Body() message: MessageLocation) {
|
||||
const whatsapp = this.whatsappSessionManager.getSession(message.sessionName)
|
||||
|
||||
@@ -46,6 +46,10 @@ export class WhatsappConfigService {
|
||||
return types ? types.split(',') : null
|
||||
}
|
||||
|
||||
get startSession(): string | undefined {
|
||||
return this.configService.get('WHATSAPP_START_SESSION', undefined)
|
||||
}
|
||||
|
||||
get(name: string): any {
|
||||
return this.configService.get(name)
|
||||
}
|
||||
|
||||
@@ -65,7 +65,8 @@ export class WhatsappService {
|
||||
this.saveQRCode(base64Qrimg)
|
||||
this.status = WhatsappStatus.SCAN_QR_CODE
|
||||
console.log('Number of attempts to read the qrcode: ', attempts);
|
||||
console.log('Terminal qrcode: ', asciiQR);
|
||||
console.log('Terminal qrcode:');
|
||||
console.log(asciiQR);
|
||||
},
|
||||
undefined,
|
||||
{
|
||||
@@ -221,6 +222,9 @@ export class WhatsappSessionManager implements OnApplicationShutdown {
|
||||
this.log.setContext('WhatsappSessionManager')
|
||||
this.cleanDownloadsFolder(this.config.filesFolder)
|
||||
this.sessions = {}
|
||||
if (config.startSession) {
|
||||
this.startSession(config.startSession)
|
||||
}
|
||||
}
|
||||
|
||||
async startSession(name: string) {
|
||||
|
||||
Reference in new issue
Block a user