https://github.com/green-api/whatsapp-api-webhook-server-java
Create a Java server endpoint to get WhatsApp messages webhooks
https://github.com/green-api/whatsapp-api-webhook-server-java
java whatsapp whatsapp-api whatsapp-bot
Last synced: about 1 month ago
JSON representation
Create a Java server endpoint to get WhatsApp messages webhooks
- Host: GitHub
- URL: https://github.com/green-api/whatsapp-api-webhook-server-java
- Owner: green-api
- License: other
- Created: 2023-10-11T08:31:42.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2024-03-05T20:30:48.000Z (about 1 year ago)
- Last Synced: 2025-02-03T16:34:22.326Z (3 months ago)
- Topics: java, whatsapp, whatsapp-api, whatsapp-bot
- Language: Java
- Homepage: https://green-api.com/en/docs/sdk/java/
- Size: 130 KB
- Stars: 3
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# whatsapp-api-webhook-server-java
- [Документация на русском языке](src/main/java/com/greenapi/server/docs/README_RU.md).
whatsapp-api-webhook-server-java is a library for integration with WhatsApp messenger using the API
service [green-api.com](https://green-api.com/en/). You should get a registration token and an account ID in
your [personal cabinet](https://console.green-api.com/) to use the library. There is a free developer account tariff.
## API
The documentation for the REST API can be found at the [link](https://green-api.com/en/docs/). The library is a wrapper
for the REST API, so the documentation at the link above also applies.
## Authorization
To send a message or perform other Green API methods, the WhatsApp account in the phone app must be authorized. To
authorize the account, go to your [cabinet](https://console.green-api.com/) and scan the QR code using the WhatsApp app.
## Example of preparing the environment for Ubuntu Server
### Updating the system
Update the system:
```shell
sudo apt update
sudo apt upgrade -y
```
### Java Installation
Java 17 must be installed on the server. [Инструкция по установке Java](https://openjdk.org/install/).
```shell
sudo apt install openjdk-17-jdk
```
### Firewall
Set up the firewall:
Allow the SSH connection:
```shell
sudo ufw allow ssh
```
Base rules:
```shell
sudo ufw default deny incoming
sudo ufw default allow outgoing
```
Allow HTTP and HTTPS connections:
```shell
sudo ufw allow http
sudo ufw allow https
```
Enable the firewall:
```shell
sudo ufw enable
```
## How to run the web server
### Import
Install the library into your server project. The library is available in the Maven central repository.
Maven
```xml
com.green-api
whatsapp-api-webhook-server-java
{{version}}
```
Gradle
```yaml
implementation group: 'com.green-api', name: 'whatsapp-api-client-java', version: 'version'
```
### Examples
#### How to run the web server
Set server options in `application.yml`.
The WebhookToken attribute is optional and does not need to be assigned a value, but it must be in `application.yml`.
If you don't want to set a password, you can simply leave the webhookToken parameter without a value.
```yaml
green-api:
webhookToken:
server:
port: 8080
```
Applications will start listening the port immediately after running the `main` method;
for this, do not forget to add the `@ComponentScan(basePackages = "com.greenapi.server")` annotation.
Link to example: [WhatsappApiServerExample.java](src/main/java/com/greenapi/server/examples/WhatsappApiServerExample.java).
```java
@SpringBootApplication
@ComponentScan(basePackages = "com.greenapi.server")
public class WhatsappApiServerExample {
public static void main(String[] args) {
SpringApplication.run(WhatsappApiServerExample.class, args);
}
}
```
The handler function class must implement the `WebhookHandler` interface and be a bean named `whatsappWebhookHandler`.
To do this, set the `@Component(value = "whatsappWebhookHandler")` annotation on the handler function class.
Link to example: [WebhookHandlerExample.java](src/main/java/com/greenapi/server/examples/WebhookHandlerExample.java).
```java
@Component(value = "whatsappWebhookHandler")
public class WebhookHandlerExample implements WebhookHandler {
@SneakyThrows
@Override
public void handle(Notification notification) {
System.out.println("START " + notification);
Thread.sleep(20000);
System.out.println("END " + notification);
}
}
```
Webhook URL: `{{your host}}/whatsapp/async/webhook`
If you want your `handle()` handler function to be executed asynchronously.
Webhook URL: `{{your host}}/whatsapp/webhook`
If you want your `handle()` handler function to be called for each webhook sequentially in one thread.
Since each notification is automatically cast to a java object, you can filter the notification by any field yourself.
A description of the structure of notification objects can be found at this link: [Documentation](https://green-api.com/docs/api/receiving/notifications-format/type-webhook/)
For convenience, all types of hooks and messages are named similarly to the documentation:
| Java object | Webhook's json object |
|---------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------|
| `TextMessageWebhook` | [TextMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/TextMessage/) |
| `TemplateMessageWebhook` | [TemplateMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/TemplateMessage/) |
| `StickerMessageWebhook` | [StickerMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/StickerMessage/) |
| `ReactionMessageWebhook` | [ReactionMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/ReactionMessage/) |
| `QuotedMessageWebhook` | [QuotedMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/QuotedMessage/) |
| `PollUpdateMessageWebhook` | [PollUpdateMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/PollUpdateMessage/) |
| `PollMessageWebhook` | [PollMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/PollMessage/) |
| `LocationMessageWebhook` | [LocationMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/LocationMessage/) |
| `ListMessageWebhook` | [ListMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/ListMessage/) |
| `GroupInviteMessageWebhook` | [GroupInviteMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/GroupInviteMessage/) |
| `FileMessageWebhook` | [imageMessage, videoMessage, documentMessage, audioMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/ImageMessage/) |
| `ExtendedTextMessageWebhook` | [ExtendedTextMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/ExtendedTextMessage/) |
| `ButtonsMessageWebhook` | [ButtonsMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/ButtonsMessage/) |
| `ContactMessageWebhook` | [ContactMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/ContactMessage/) |
| `ContactsArrayMessageWebhook` | [ContactMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/incoming-message/ContactsArrayMessage/) |
| `TemplateButtonsReplyMessageWebhook` | [TemplateButtonsReplyMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/selected-buttons/TemplateButtonsReplyMessage/) |
| `ButtonsResponseMessageWebhook` | [ButtonsResponseMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/selected-buttons/ButtonsResponseMessage/) |
| `ListResponseMessageWebhook` | [ListResponseMessage](https://greenapi.com/en/docs/api/receiving/notifications-format/selected-buttons/ListResponseMessage/) |
### Running the application
For JAR file:
```shell
java -jar your_app.jar
```
If using Maven, run from the project directory:
```shell
./mvnw spring-boot:run
```
## Service methods documentation
[Service methods documentation](https://green-api.com/en/docs/api/)
## License
Licensed under [
Attribution-NoDerivatives 4.0 International (CC BY-ND 4.0)
](https://creativecommons.org/licenses/by-nd/4.0/) terms.
Please see file [LICENSE](LICENSE.txt).