vk_api

The vk_api.bot_longpoll module provides classes for interacting with the VK Bots Long Poll API. It is designed to handle incoming events from VK bots using the long polling method.

Key classes include:

• VkBotLongPoll: The main class used to manage the long polling connection and receive events.
• VkBotEvent: The base class for all bot events.
• VkBotMessageEvent: A specialized subclass of VkBotEvent representing incoming messages.

The vk_api.keyboard module provides tools for creating interactive keyboards for VK bots. It consists of three main components:

1. VkKeyboard: The main class used to construct the keyboard layout.
2. VkKeyboardButton: Represents an individual button within the keyboard.
3. VkKeyboardColor: Defines the visual color/style of the buttons.

You use these classes to build a structured keyboard that can be sent to users via the VK API.

The VkRequestsPool module allows you to group multiple API requests together and execute them in a single batch using the execute method. This is useful for reducing the number of network calls and optimizing interaction with the VK API.

Key components include:

• VkRequestsPool: The main class used to collect and batch requests.
• RequestResult: Represents the result of an individual request within the pool.
• vk_request_one_param_pool: A utility function for handling single-parameter request pooling.

To use vk_api, initialize a VkApi session with your phone number and password, call .auth() to authenticate, and use .get_api() to access the VK API methods. The following example demonstrates how to post a message to a wall.

import vk_api

vk_session = vk_api.VkApi('+71234567890', 'mypassword')
vk_session.auth()

vk = vk_session.get_api()

print(vk.wall.post(message='Hello world!'))

When using the provided examples, you must replace the placeholder credentials with your actual VK account and group information:

1. Replace 'python@vk.ru' with your VK login.
2. Replace 'mypassword' with your VK password.
3. Replace 'bot_api_token' with your specific VK group token.

Install the vk_api package using the standard Python package manager.

python3 -m pip install vk_api

The vk_api.longpoll module provides the VkLongPoll class, which is used to interact with the VK User Long Poll API. This allows your bot to receive real-time updates (events) from the VK platform.

To use it, you will typically instantiate VkLongPoll and iterate over incoming Event objects. The module includes several supporting classes to categorize and filter these events:

• VkLongPollMode: Defines the mode of operation.
• VkEventType: Specifies the type of event received (e.g., messages, notifications).
• VkPlatform: Information about the platform where the event originated.
• VkOfflineType: Indicates the offline status.
• VkMessageFlag: Flags related to message properties.
• VkPeerFlag: Flags related to the peer (user or chat) involved in the event.
• Event: The base class for all incoming event objects.

Install the vk_api package using pip3 to begin creating scripts for the VK (vk.ru) social network.

# pip3 install vk_api

The vk_api library provides hooks to handle security challenges like Captchas and Two-Factor Authentication (2FA).

Captchas

When a captcha is encountered, the library raises a Captcha exception. You can provide a captcha_handler during VkApi initialization to process it automatically.

Two-Factor Authentication (2FA)

When 2FA is required, the library looks for an auth_handler provided during initialization. This handler must be a function that returns a tuple: (code_string, remember_device_boolean).