vkapi-lib
Библиотека для работы с VK API.
Содержание
- Установка
- Вызов метода
- Лонгполл
- Отправка сообщения
- Методы загрузки медиа
- Объект message
- Конструктор сообщений
Установка
npm install vkapi-lib
Подключение в проект:
const vk =
Методы
Инитализация с токеном
const API = 'ключ доступа'
В конструкторе можно указывать неограниченное число токенов (каждый токен как отдельный агрумент)
const API = 'ключ доступа1' 'ключ доступа2'
Авторизация по логину и паролю
let API auth
user | group)
Authorization Code Flow (const auth = let API auth
Client Credentials Flow)
Получение сервисного ключа доступа (const auth = let API auth
VK API
Вызов метода
method
(string) - название методаoptions
(object) - параметры вызоваcallback
(function, string) - callback-функция (по умолчанию дефолтный каллбек)token
(int, string) - порядковый идентификатор токена (по порядку, указанному в конструкторе) | токен в строковом формате (необязательный параметр)
Пример использования:
API API API API
Лонгполл
callback
(function) - callback-функция (по умолчанию дефолтный каллбек)params
(object) - параметры лонгполлаtoken
(int, string)
Пример использования:
API
Событие: новое сообщение
callback
(function) - callback-функция (по умолчанию дефолтный каллбек)token
(int, string)
Пример использования:
API
Подробнее про объект message
Отправка сообщения
text
(string) - текст сообщенияoptions
(object) - параметры отправкиpeer
(int, object) - адресат (user_id для пользователя, 2e9+chat_id для беседы, -group_id для сообщества) в числовом формате, либо объект сообщения, содерржащий в себе параметрpeer_id
callback
(function) - callback-функция (по умолчанию дефолтный каллбек) для возврата статуса отправленияtoken
(int, string)
Пример использования:
API API
Отправка стикера
sticker_id
(int) - идентификатор стикераpeer
(int, object) - адресат (user_id для пользователя, 2e9+chat_id для беседы, -group_id для сообщества) в числовом формате, либо объект сообщения, содерржащий в себе параметрpeer_id
callback
(function) - callback-функция (по умолчанию дефолтный каллбек) для возврата статуса отправленияtoken
(int, string)
Пример использования:
API
подробнее)
Методы загрузки медиа (// Загрузка фотографий в альбом // Загрузка фотографий на стену // Загрузка главной фотографии пользователя или сообщества // Загрузка фотографии в личное сообщение // Загрузка главной фотографии для чата // Загрузка фотографии для товара // Загрузка фотографии для подборки товаров // Загрузка аудиозаписей // Загрузка видеозаписей // Загрузка документов // Загрузка документов на стену // Загрузка документа в личное сообщения // в данный момент недоступно // Загрузка обложки сообщества
data
(string | array) - путь к файлу на диске | URLoptions
(object) - опции загрузкиcallback
(function) - callback-функция (по умолчанию дефолтный каллбек) для возврата статуса отправленияtoken
(int, string)
Примеы использования:
API API API API API API API API API API
Объект message
id
(ing) - идентификатор сообщенияflags
(int) - флаги сообщенияpeer_id
(int) - адресатts
(int) - время UNIX timestamptext
(string) - текст сообщенияattachments
(object) - вложения сообщенияrandom_id
(int) - значениеrandom_id
, переданное отправителемsender_id
(int) - иднтификатор отправителяout
(bool) - флаг исходящего сообщения
Методы объекта message
// пометить сообщение как прочитанноеdelete // удалить сообщение // пометить сообщение как спам // восстановить удалённое сообщение (можно в течение 5 часов после удаления) // проверка флага сообщения // получение подробного объекта вложений сообщения
flag
(int) - флаг (объект: LP_MESSAGE_FLAGS, API.flags) (подробнее)callback
(function) - callback-функция (по умолчанию дефолтный каллбек) для возврата статуса отправления
Примеы использования:
API
Пример передаваемых getMedia данных в callback
read_state: 0 attachments: type: 'photo' id: 456255039 album_id: -6 owner_id: 168557207 photo_75: 'https://pp.userapi.com/c638826/v638826207/4f93d/3IMgDciIdlk.jpg' photo_130: 'https://pp.userapi.com/c638826/v638826207/4f93e/yI5wtwl1qyw.jpg' photo_604: 'https://pp.userapi.com/c638826/v638826207/4f93f/f4DeBtdkj-A.jpg' photo_807: 'https://pp.userapi.com/c638826/v638826207/4f940/rJA41miL5Hw.jpg' photo_1280: 'https://pp.userapi.com/c638826/v638826207/4f941/J2gLGI92J0I.jpg' width: 1013 height: 599 text: '' date: 1498734394 post_id: 6223 item: 'photo168557207_456255039' type: 'audio' id: 456239534 owner_id: 168557207 artist: 'Xavier Wulf' title: 'Tortuga' duration: 158 date: 1492628273 content_restricted: 1 url: '' genre_id: 1001 is_hq: false item: 'audio168557207_456239534' }
Конструктор сообщений
token
(int, string)
Методы
// Задать текст сообщения // Прикрепить изображения // Прикрепить видеозаписи // Прикрепить аудизаписи // Прикрепить документы // Прикрепить голосовое сообщение (форматы: .ogg, .opus) // Прикрепить граффити (форматы: .jpg, .png, .gif) // Прикрепить запись на стене // Прикрепить товары // Прикрепить геопозицию // Прикрепить сообщения // Отправить сообщение адресату
text
(string) - текст сообщенияconnect
(bool) - задание коннектацииdata
(string, object) - путь к файлу на диске | URL | идентификатор в VK (переменное количество аргументов, каждое вложение заданного типа через запятую)post
(string) - идентификатор поста в VKproduct
(string) - идентификатор товара/магазина в VKlat
(float) - шитора на картеlong
(float) - долгота на карте- 'message' (int, string, array) - идентификаторы сообщений для пересылки
peer
(int, object) - адресат (user_id для пользователя, 2e9+chat_id для беседы, -group_id для сообщества) в числовом формате, либо объект сообщения, содерржащий в себе параметрpeer_id
Пример использования:
API text'Test message'