GREEN-API

https://green-api.com/en/docs/
Admin
GREEN-API offers an API for integrating with WhatsApp, providing functionalities for sending and...
Tokens:667,331
Snippets:4,780
Trust Score:9.1
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install and run the custom adapter example

Source: https://green-api.com/en/docs/sdk/nodejs/integration-platform

Commands to install dependencies and start the example from the `examples/custom-adapter` directory.

```bash
cd examples/custom-adapter
npm install
npm start

```

--------------------------------

### Install the library with go get

Source: https://green-api.com/en/docs/chatbots/golang/chat-gpt-golang

Installs the whatsapp-chatgpt-go library and its required dependencies: github.com/green-api/whatsapp-chatbot-golang and github.com/sashabaranov/go-openai.

```bash
go get github.com/green-api/whatsapp-chatgpt-go

```

--------------------------------

### Install the webhook server package

Source: https://green-api.com/en/docs/sdk/golang/server/launch

Installs the Green API webhook server package using go get.

```bash
go get github.com/green-api/whatsapp-api-webhook-server-golang

```

--------------------------------

### Initialize Go module

Source: https://green-api.com/en/docs/chatbots/golang/start

Run this command to create a new Go module named 'example' before installing the library.

```bash
go mod init example

```

--------------------------------

### Local server example for transferring data

Source: https://green-api.com/en/docs/chatbots/python/chatbot-demo/chatbot-demo-gpt-py

Python script for a local server that responds to GET requests with JSON data containing user ID, API token, and file links. Start this server before starting the bot.

```python
#!/usr/bin/env python3

from http.server import BaseHTTPRequestHandler, HTTPServer
from urllib.parse import urlparse
import json

class RequestHandler(BaseHTTPRequestHandler):
    def do_GET(self):
        parsed_path = urlparse(self.path)
        self.send_response(200)
        self.end_headers()
        self.wfile.write(json.dumps({
            'user_id': 'Ваш ID',
            'api_token_id': 'ВАШ ТОКЕН',
            'link_pdf': 'url ССЫЛКА НА ФАЙЛ',
            'link_jpg': 'url ССЫЛКА НА картинку',
            'link_audio_ru': 'url ССЫЛКА НА аудио файл',
            'link_video_ru': 'url ССЫЛКА НА видео файл',
            'link_audio_en': 'url ССЫЛКА НА аудио файл',
            'link_video_en': 'url ССЫЛКА НА видео файл'
        }).encode())
        return

if __name__ == '__main__':
    server = HTTPServer(('localhost', 8000), RequestHandler)
    print('Starting server at http://localhost:8000')
    server.serve_forever()

```

--------------------------------

### Build and start the adapter

Source: https://green-api.com/en/docs/integration/gohighlevel/development

Build the application and start it in production mode.

```bash
# Build the application
npm run build

# Start in production mode
npm run start:prod

```

--------------------------------

### Download example web server

Source: https://green-api.com/en/docs/sdk/golang/server/ubuntu

Downloads the example main.go file from the Green API repository.

```bash
wget https://raw.githubusercontent.com/green-api/whatsapp-api-webhook-server-golang/master/examples/main.go

```

--------------------------------

### Install phonenumbers package

Source: https://green-api.com/en/docs/faq/features-of-sending-and-receiving-messages-from-different-countries

Command to install the Python 'phonenumbers' library, which is required for the number formatting example.

```bash
pip install phonenumbers
```

--------------------------------

### Set up environment variables

Source: https://green-api.com/en/docs/integration/gohighlevel/development

Create a .env file with the required configuration values for the adapter.

```bash
DATABASE_URL="mysql://USER:PASSWORD@HOST:PORT/DATABASE_NAME"
APP_URL="https://your-adapter-domain.com"
GHL_CLIENT_ID="your_ghl_client_id_from_developer_portal"
GHL_CLIENT_SECRET="your_ghl_client_secret_from_developer_portal"
GHL_CONVERSATION_PROVIDER_ID="your_ghl_conversation_provider_id_from_app_settings"
GHL_SHARED_SECRET="your_shared_secret_from_developer_portal"

```

--------------------------------

### Launch application

Source: https://green-api.com/en/docs/integration/telegram/integration-setup

Starts the application.

```bash
npm start

```

--------------------------------

### ClearWebhooksQueue Java Unirest example

Source: https://green-api.com/en/docs/api/queues/ClearWebhooksQueue

Java example using Unirest to call the clearWebhooksQueue endpoint with a GET request.

```java
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/clearWebhooksQueue/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);

```

--------------------------------

### Example instance connection

Source: https://green-api.com/en/docs/integration/telegram/integration-setup

Example command to connect a Green-API instance using a sample instance ID and API token.

```text
/instance 1101111111 abcdef123456789abcdef123456789

```

--------------------------------

### Java Unirest request example for GetChats

Source: https://green-api.com/en/docs/api/service/GetChats

Java example using Unirest to perform a GET request to the GetChats endpoint.

```java
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getChats/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);
```

--------------------------------

### Download and run example script

Source: https://green-api.com/en/docs/sdk/python/pythonWebhookServer_2.0/serverUbuntu

Downloads the receive_all_with_counter.py example script from GitHub and runs it. The script outputs information about received webhooks to the console.

```bash
wget https://github.com/green-api/whatsapp-api-webhook-server-python-v2/blob/master/examples/receive_all_with_counter.py
python3 receive_all_with_counter.py

```

--------------------------------

### Java Spring request example for GetChats

Source: https://green-api.com/en/docs/api/service/GetChats

Java example using RestTemplate to perform a GET request to the GetChats endpoint.

```java
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getChats/")
    .append({{apiTokenInstance}});

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class);
System.out.println(response);
```

--------------------------------

### Python request example for GetChats

Source: https://green-api.com/en/docs/api/service/GetChats

Python example using the requests library to perform a GET request to the GetChats endpoint.

```python
import requests

url = "{{apiUrl}}/waInstance{{idInstance}}/getChats/{{apiTokenInstance}}"

payload = {}
headers= {}

response = requests.request("GET", url, headers=headers, data = payload)

print(response.text.encode('utf8'))
```

--------------------------------

### Initialize and start WhatsappGptBot

Source: https://green-api.com/en/docs/chatbots/nodejs/nodejs-v2/start

Import WhatsappGptBot, create an instance with your credentials and OpenAI configuration, then call start() to launch the bot.

```javascript
import { WhatsappGptBot } from '@green-api/whatsapp-chatgpt';

// Initialize the bot
const bot = new WhatsappGptBot({
idInstance: "your-instance-id",
apiTokenInstance: "your-token",
openaiApiKey: "your-openai-api-key",
model: "gpt-4o",
systemMessage: "You are a useful assistant."
});

// Launch the bot
bot.start();

```

--------------------------------

### ClearWebhooksQueue VBA example

Source: https://green-api.com/en/docs/api/queues/ClearWebhooksQueue

VBA example using MSXML2.XMLHTTP to send a GET request to the clearWebhooksQueue endpoint and print the response.

```vb
Sub ClearWebhooksQueue()
    Dim url As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/waInstance{{idInstance}}/clearWebhooksQueue/{{apiTokenInstance}}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    http.Open "GET", url, False
    http.Send

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    ' Range("A1").Value = response

    Set http = Nothing
End Sub

```

--------------------------------

### main.go - Initialize and launch the bot

Source: https://green-api.com/en/docs/chatbots/golang/chatbot-demo

The main function loads environment variables, initializes the base bot, registers a GPT bot, sets the start scene, and starts receiving notifications.

```go
func main() {
    // Load environment variables
    err := godotenv.Load(".env")

    // Initialize the base bot
    baseBot := chatbot.NewBot(idInstance, authToken)

    // Initialize and register the GPT bot
    gptConfig := gptbot.GPTBotConfig{
       IDInstance:       idInstance,
       APITokenInstance: authToken,
       OpenAIApiKey:     openaiToken,
       Model:            gptbot.ModelGPT4o,
       MaxHistoryLength: 10,
       SystemMessage:    "You are a helpful WhatsApp assistant.",
    }
    gptHelper := gptbot.NewWhatsappGptBot(gptConfig)
    registry.RegisterGptHelper(gptHelper)

    // Set the start scene and launch the bot
    baseBot.SetStartScene(scenes.StartScene{})
    baseBot.StartReceivingNotifications()
}
```

--------------------------------

### Java Unirest Request Example for GetStatusInstance

Source: https://green-api.com/en/docs/api/account/GetStatusInstance

Java example using Unirest to send a GET request to the GetStatusInstance endpoint and print the response.

```java
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getStatusInstance/")
    .append({{apiTokenInstance}});

var response = Unirest.get(requestUrl.toString())
    .header("Content-Type", "application/json")
    .asString();

System.out.println(response);
```

--------------------------------

### Go: main function in main.go

Source: https://green-api.com/en/docs/chatbots/demo/chatbot-demo-go

Initializes the bot with instance and token, sets up error handling, configures webhook settings, sets the starting scene, and starts receiving notifications.

```go
func main() {
     bot := chatbot.NewBot(idInstance, apiTokenInstance) //Initializing the bot with INSTANCE and TOKEN parameters from constants

     go func() {                                         //Error handling
        for err := range bot.ErrorChannel {
            if err != nil {
                log.Println(err)
            }
        }
     }()     

     if _, err := bot.GreenAPI.Methods().Account().SetSettings(map[string]interface{}{ //Set instance settings
         "incomingWebhook": "yes",
         "outgoingMessageWebhook": "yes",
         "outgoingAPIMessageWebhook": "yes",
         "pollMessageWebhook": "yes",
         "markIncomingMessagesReaded": "yes",
     }); err != nil {
         bot.ErrorChannel <- err
     }

     bot.SetStartScene(scenes.StartScene{}) //Set the bot's starting scene

     bot.StartReceivingNotifications() //Start the bot
}

```

--------------------------------

### Project structure of the custom adapter example

Source: https://green-api.com/en/docs/sdk/nodejs/integration-platform

Directory layout of the example project, showing the source files and configuration files.

```plaintext
examples/
└── custom-adapter/
    ├── src/
    │   ├── main.ts
    │   ├── simple-adapter.ts
    │   ├── simple-transformer.ts
    │   ├── simple-storage.ts
    │   └── types.ts
    ├── .env
    └── package.json

```

--------------------------------

### VBA request example for GetChats

Source: https://green-api.com/en/docs/api/service/GetChats

VBA example using MSXML2.XMLHTTP to perform a GET request to the GetChats endpoint and output the response to cell A1.

```vba
Sub getChats()
    Dim url As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/waInstance{{idInstance}}/getChats/{{apiTokenInstance}}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    http.Open "GET", url, False
    http.Send

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    Range("A1").Value = response

    Set http = Nothing
End Sub
```

--------------------------------

### Request body example for GetChatHistory

Source: https://green-api.com/en/docs/api/journals/GetChatHistory

Example request body to get the last 10 messages. The chatId is mandatory, count is optional and defaults to 100.

```json
{
    "chatId": "79876543210@c.us",
    "count": 10
}
```

--------------------------------

### Complete example with command filter

Source: https://green-api.com/en/docs/chatbots/python/filters

A complete example that handles a command and sends a file response.

```python
@bot.router.message(command="help")
def message_handler(notification: Notification) -> None:
    notification.answer_with_file(file="help.png")


bot.run_forever()

```

--------------------------------

### GET request URL for GetMessagesCount

Source: https://green-api.com/en/docs/api/queues/GetMessagesCount

Executes a GET request to the address {{apiUrl}}/waInstance{{idInstance}}/getMessagesCount/{{apiTokenInstance}} to get the count of messages in the queue. The `apiUrl`, `idInstance`, and `apiTokenInstance` parameters are described in the Before you start section.

```http
GET
{{apiUrl}}/waInstance{{idInstance}}/getMessagesCount/{{apiTokenInstance}}

```

--------------------------------

### Delphi GET request to getWaSettings

Source: https://green-api.com/en/docs/api/account/GetWaSettings

Uses TNetHTTPClient to send a GET request and prints the response or error. The example includes hardcoded ID_INSTANCE and API_TOKEN_INSTANCE values.

```Delphi
program GetWaSettings;

{$APPTYPE CONSOLE}

uses
System.SysUtils,
System.Classes, System.Net.HttpClient, System.Net.URLClient, System.Net.HttpClientComponent;

var
HttpClient: TNetHTTPClient;
RequestHeaders: TNetHeaders;
Response: IHTTPResponse;
EndpointURL, ID_INSTANCE, API_TOKEN_INSTANCE: string;

begin
ID_INSTANCE := '110100001';
API_TOKEN_INSTANCE := 'd75b3a66374942c5b3c019c698abc2067e151558acbd451234';

EndpointURL := 'https://api.green-api.com/waInstance' + ID_INSTANCE + '/getWaSettings/' + API_TOKEN_INSTANCE;

HttpClient := TNetHTTPClient.Create(nil);
RequestHeaders := [
    TNetHeader.Create('Content-Type', 'application/json')
];

try
    Response := HTTPClient.Get(EndpointURL, nil, RequestHeaders);

    if Response.StatusCode = 200 then
    Writeln('[Response]: ' + Response.ContentAsString)
    else
    Writeln('[ERROR ' + IntToStr(Response.StatusCode) + ']:' + Response.StatusText + '' + Response.ContentAsString);

    readln;
except
    on E: Exception do
    Writeln(E.ClassName, ': ', E.Message);
end;

HttpClient.Free;

end.

```

--------------------------------

### Run the application

Source: https://green-api.com/en/docs/sdk/cpp/server/serverLinux

Executes the built binary. The server listens on the port specified in config.json (default 5000).

```bash
./build/bin/whatsapp-api-webhook-server-cpp

```

--------------------------------

### Request body example for user avatar

Source: https://green-api.com/en/docs/api/service/GetAvatarAsync

Example JSON body to get the avatar of a user. Specify the user's number in chatId with the @c.us suffix.

```json
{
  "chatId": "79876543210@c.us"
}
```

--------------------------------

### Java Spring Request Example for GetStatusInstance

Source: https://green-api.com/en/docs/api/account/GetStatusInstance

Java example using Spring's RestTemplate to send a GET request to the GetStatusInstance endpoint and print the response.

```java
var restTemplate = new RestTemplate();
var requestUrl = new StringBuilder();
requestUrl
    .append({{apiUrl}})
    .append("/waInstance").append({{idInstance}})
    .append("/getStatusInstance/")
    .append({{apiTokenInstance}});

var response = restTemplate.exchange(requestUrl.toString(), HttpMethod.GET, null, String.class);
System.out.println(response);
```

--------------------------------

### Install Go protoc plugins

Source: https://green-api.com/en/docs/sdk/grpc

Installs the protoc-gen-go and protoc-gen-go-grpc plugins for Go using go install. Required for local generation with buf.

```shell
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
```

--------------------------------

### cURL: GET lastIncomingMessages with minutes parameter

Source: https://green-api.com/en/docs/api/journals/LastIncomingMessages

Uses curl to send a GET request to the lastIncomingMessages endpoint with an optional minutes query parameter (set to 3240 in the example).

```cURL
curl --location '{{apiUrl}}/waInstance{{idInstance}}/lastIncomingMessages/{{apiTokenInstance}}?minutes=3240'

```

--------------------------------

### Full bot example with handlers

Source: https://green-api.com/en/docs/chatbots/python/full_example

Complete bot example that responds to the /start command and handles text messages for reporting problems, showing office address, rates, and calling support. Uses the router decorators and runs the bot with bot.run_forever().

```python
@bot.router.message(command="start")
def message_handler(notification: Notification) -> None:
    sender_data = notification.event["senderData"]
    sender_name = sender_data["senderName"]

    notification.answer(
        (
            f"Hello, {sender_name}. Here's what I can do:\n\n"
            "1. Report a problem\n"
            "2. Show office address\n"
            "3. Show available rates\n"
            "4. Call a support operator\n\n"
            "Choose a number and send to me."
        )
    )


@bot.router.message(text_message=["1", "Report a problem"])
def report_problem_handler(notification: Notification) -> None:
    notification.answer(
        "https://github.com/green-api/issues/issues/new", link_preview=False
    )


@bot.router.message(text_message=["2", "Show office address"])
def show_office_address_handler(notification: Notification) -> None:
    chat = notification.get_chat()

    notification.api.sending.sendLocation(
        chatId=chat, latitude=55.7522200, longitude=37.6155600
    )


@bot.router.message(text_message=["3", "Show available rates"])
def show_available_rates_handler(notification: Notification) -> None:
    notification.answer_with_file("data/rates.png")


@bot.router.message(text_message=["4", "Call a support operator"])
def call_support_operator_handler(notification: Notification) -> None:
    notification.answer("Good. A tech support operator will contact you soon.")


bot.run_forever()

```

--------------------------------

### VBA Request Example for GetStatusInstance

Source: https://green-api.com/en/docs/api/account/GetStatusInstance

VBA example using MSXML2.XMLHTTP to send a GET request to the GetStatusInstance endpoint. Includes commented code to output the response to a cell.

```vb
Sub GetStatusInstance()
    Dim url As String
    Dim http As Object
    Dim response As String

    ' The apiUrl, idInstance and apiTokenInstance values are available in console, double brackets must be removed
    url = "{{apiUrl}}/waInstance{{idInstance}}/GetStatusInstance/{{apiTokenInstance}}"

    Set http = CreateObject("MSXML2.XMLHTTP")

    http.Open "GET", url, False
    http.Send

    response = http.responseText

    Debug.Print response

    ' Outputting the answer to the desired cell
    ' Range("A1").Value = response

    Set http = Nothing
End Sub
```

--------------------------------

### Install the Green API PHP client with Composer

Source: https://green-api.com/en/docs/sdk/php/phpClient/creategroup

Run this command to install the green-api/whatsapp-api-client-php package via Composer.

```bash
composer require green-api/whatsapp-api-client-php

```

--------------------------------

### Java Spring request to get messages count

Source: https://green-api.com/en/docs/api/queues/GetMessagesCount

Java Spring example for calling the getMessagesCount method. Uses the RestTemplate to send a GET request to the queue count endpoint.

```java
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;

public class GetMessagesCount {
    public static void main(String[] args) {
        String url = "{{apiUrl}}/waInstance{{idInstance}}/getMessagesCount/{{apiTokenInstance}}";
        RestTemplate restTemplate = new RestTemplate();
        HttpHeaders headers = new HttpHeaders();
        headers.setContentType(MediaType.APPLICATION_JSON);
        HttpEntity<String> entity = new HttpEntity<String>(headers);
        ResponseEntity<String> response = restTemplate.exchange(url, HttpMethod.GET, entity, String.class);
        System.out.println(response.getBody());
    }
}
```

```java
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;

public class GetMessagesCount {
    public static void main(String[] args) {
        String url = 
```

```java
import org.springframework.http.HttpEntity;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod;
import org.springframework.http.MediaType;
import org.springframework.http.ResponseEntity;
import org.springframework.web.client.RestTemplate;

public class GetMessagesCount {
    public static void main(String[] args) {
        String url = "{{apiUrl}}/waInstance{{idInstance}}/getMessagesCount/{{apiTokenInstance}}";
        RestTemplate restTemplate = new RestTemplate();
        HttpHeaders headers = new HttpHeaders();
        HttpEntity<String> entity = new HttpEntity<>(headers);
        ResponseEntity<String> response = restTemplate.exchange(url, HttpMethod.GET, entity, String.class);
        System.out.println(response.getBody());
    }
}
```

--------------------------------

### BotStarter main method

Source: https://green-api.com/en/docs/chatbots/demo/chatbot-demo-java

Entry point of the chatbot. Initializes the Spring context, creates the bot with INSTANCE and TOKEN placeholders, sets the starting scene to Start, and begins receiving notifications.

```java
public static void main(String[] args) {
     var context = SpringApplication.run(BotStarter.class, args); //Initiate the Spring application context
     var botFactory = context.getBean(BotFactory.class); //Import BotFactory bean from context

     var bot = botFactory.createBot( //Initialize the bot with INSTANCE and TOKEN parameters
     "{{INSTANCE}}",
     "{{TOKEN}}");

     bot.setStartScene(new Start()); //Setting the bot's starting scene

     bot.startReceivingNotifications(); //Start the bot
     }
```

--------------------------------

### Initialize Go module

Source: https://green-api.com/en/docs/sdk/golang/client_2.0/create_group

Run this command to create a new Go module for your project if you haven't already.

```bash
go mod init ModuleName

```
Tokens:
Raw