Java VK Bots Long Poll API

A Java library to create VK bots using Bots Long Poll API.

Description

An easy-to-use and lightweight Java library that implements Bots Long Poll API. Uses API version: 5.131.

Note

This library keeps on improving. Feel free to create issues or pull requests.

Third-party dependencies

This library uses the next third-party dependencies:

• Gson
• SLF4J
• OkHttp

Requirements

1. Java 8 or higher
2. Maven or other build tool

Quickstart

1. Create VK Community.
2. Go to Manage - API usage - Access tokens and create access_token.
3. Add the library to your Maven project:

   <dependency>
       <groupId>com.github.yvasyliev</groupId>
       <artifactId>java-vk-bots-longpoll-api</artifactId>
       <version>VERSION</version>
   </dependency>
   

   • Replace VERSION with the latest release.
4. Extend LongPollBot class and override necessary methods:

   import api.longpoll.bots.LongPollBot;
   import api.longpoll.bots.exceptions.VkApiException;
   import api.longpoll.bots.model.events.messages.MessageNew;
   import api.longpoll.bots.model.objects.basic.Message;
   
   public class HelloBot extends LongPollBot {
      @Override
      public void onMessageNew(MessageNew messageNew) {
         try {
            Message message = messageNew.getMessage();
            if (message.hasText()) {
               String response = "Hello! Received your message: " + message.getText();
               vk.messages.send()
                       .setPeerId(message.getPeerId())
                       .setMessage(response)
                       .execute();
            }
         } catch (VkApiException e) {
             e.printStackTrace();
         }
      }
   
      @Override
      public String getAccessToken() {
         return "your_access_token";
      }
   
      public static void main(String[] args) throws VkApiException {
         new HelloBot().startPolling();
      }
   }
   

How to send photos or documents?

Easy:

import api.longpoll.bots.LongPollBot;
import api.longpoll.bots.exceptions.VkApiException;
import api.longpoll.bots.model.events.messages.MessageNew;
import api.longpoll.bots.model.objects.basic.Message;
import java.io.File;

public class HelloBot extends LongPollBot {
   @Override
   public void onMessageNew(MessageNew messageNew) {
      try {
         Message message = messageNew.getMessage();
         vk.messages.send()
                 .setPeerId(message.getPeerId())
                 .setMessage("Sending some files to you...")
                 .addPhoto(new File("your_photo.png")) // to send photo as photo
                 .addDoc(new File("your_photo.png")) // to send photo as document
                 .execute();
      } catch (VkApiException e) {
         e.printStackTrace();
      }
   }
}

More Examples

Find more examples of bot usage here.

Async execution

Each API method can be executed asynchronously:

import api.longpoll.bots.LongPollBot;
import api.longpoll.bots.exceptions.VkApiException;
import api.longpoll.bots.methods.impl.messages.Send;import api.longpoll.bots.model.events.messages.MessageNew;
import api.longpoll.bots.model.objects.basic.Message;
import java.io.File;import java.util.concurrent.CompletableFuture;

public class HelloBot extends LongPollBot {
   @Override
   public void onMessageNew(MessageNew messageNew) {
      CompletableFuture<Send.ResponseBody> future = vk.messages.send()
               .setPeerId(message.getPeerId())
               .setMessage("Sending message asynchronously...")
               .executeAsync();
   }
}

Bot events

LongPollBot can handle the next events:

Logging

This library uses SLF4J API to log all events. You can add any SLF4J binding to your project to register events the way you want.

It is highly recommended enabling DEBUG log level to see sent and received data.