vkapi-lib
Advanced tools
Readme
Библиотека для работы с VK API.
npm install vkapi-lib
Подключение в проект:
const vk = require('vkapi-lib')
const API = new vk.API('ключ доступа')
В конструкторе можно указывать неограниченное число токенов (каждый токен как отдельный агрумент)
const API = new vk.API('ключ доступа1', 'ключ доступа2')
let API
auth.password('login', 'password', resp => {
if (resp.error) {
return console.log(resp.error)
}
API = new vk.API(resp.access_token)
})
const auth = new vk.Auth
let API
auth.acf(client_id, client_secret, redirect_uri, code, resp => {
if (resp.error) {
return console.log(resp.error)
}
API = new vk.API(resp.access_token)
})
const auth = new vk.Auth
let API
auth.ccf(client_id, client_secret, grant_type, resp => {
if (resp.error) {
return console.log(resp.error)
}
API = new vk.API(resp.access_token)
})
call(method, options = {}, callback = this.default_callback, token)
method (string) - название методаoptions (object) - параметры вызоваcallback (function, string) - callback-функция (по умолчанию дефолтный каллбек)token (int, string) - порядковый идентификатор токена (по порядку, указанному в конструкторе) | токен в строковом формате (необязательный параметр)Пример использования:
API.call('users.get', {
user_ids: 1
}, (error, response) => {
if (error) {
console.log(error)
}
console.log(response[0])
})
API.call('users.get', {
user_ids: 1
}, 'console.log(error, response)')
API.call('users.get', {
user_ids: 1
})
API.call('users.get')
longpoll(callback, params, token)
callback (function) - callback-функция (по умолчанию дефолтный каллбек)params (object) - параметры лонгполлаtoken (int, string)Пример использования:
API.longpoll(data => {
console.log(data)
})
lp_message(callback, token)
callback (function) - callback-функция (по умолчанию дефолтный каллбек)token (int, string)Пример использования:
API.lp_message(message => {
console.log(message)
})
Подробнее про объект message
send(text, options, peer, callback, token)
text (string) - текст сообщенияoptions (object) - параметры отправкиpeer (int, object) - адресат (user_id для пользователя, 2e9+chat_id для беседы, -group_id для сообщества) в числовом формате, либо объект сообщения, содерржащий в себе параметр peer_idcallback (function) - callback-функция (по умолчанию дефолтный каллбек) для возврата статуса отправленияtoken (int, string)Пример использования:
API.lp_message(message => {
API.send('Example', {
forward_messages: message.id
}, message)
})
API.send('Example', {}, 168557207)
sticker(sticker_id, peer, callback, token)
sticker_id (int) - идентификатор стикераpeer (int, object) - адресат (user_id для пользователя, 2e9+chat_id для беседы, -group_id для сообщества) в числовом формате, либо объект сообщения, содерржащий в себе параметр peer_idcallback (function) - callback-функция (по умолчанию дефолтный каллбек) для возврата статуса отправленияtoken (int, string)Пример использования:
API.sticker(101, 168557207)
// Загрузка фотографий в альбом
uploadPhoto(data, options, callback, token)
// Загрузка фотографий на стену
uploadPhotoOnWall(data, options, callback, token)
// Загрузка главной фотографии пользователя или сообщества
uploadOwnerPhoto(data, options, callback, token)
// Загрузка фотографии в личное сообщение
uploadMessagesPhoto(data, callback, token)
// Загрузка главной фотографии для чата
uploadChatPhoto(data, options, callback, token)
// Загрузка фотографии для товара
uploadMarketPhoto(data, options, callback, token)
// Загрузка фотографии для подборки товаров
uploadMarketAlbumPhoto(data, options, callback, token)
// Загрузка аудиозаписей
uploadAudio(data, options, callback, token)
// Загрузка видеозаписей
uploadVideo(data, options, callback, token)
// Загрузка документов
uploadDocs(data, options, callback, token)
// Загрузка документов на стену
uploadWallDocs(data, options, callback, token)
// Загрузка документа в личное сообщения
uploadMessagesDocs(data, options, callback, token) // в данный момент недоступно
// Загрузка обложки сообщества
uploadOwnerCoverPhoto(data, options, callback, token)
data (string | array) - путь к файлу на диске | URLoptions (object) - опции загрузкиcallback (function) - callback-функция (по умолчанию дефолтный каллбек) для возврата статуса отправленияtoken (int, string)Примеы использования:
API.uploadPhoto(['test1.jpg', 'https://nodei.co/npm/vkapi-lib.png'], {
album_id: 169819278,
group_id: 123396984
}, (error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
API.uploadPhotoOnWall('https://nodei.co/npm/vkapi-lib.png', {
group_id: 123396984
}, (error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
API.uploadPhotoOnWall('test1.jpg', {
group_id: 123396984
}, (error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
API.uploadOwnerPhoto('test1.jpg', {
owner_id: -123396984
}, (error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
API.uploadMessagesPhoto('test1.jpg', (error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
API.uploadChatPhoto('test1.jpg', {
chat_id: 103
})
API.uploadMarketPhoto('test1.jpg', {
group_id: -123396984,
main_photo: true
})
API.uploadMarketAlbumPhoto('test1.jpg', {
group_id: -123396984
})
API.uploadAudio('test.mp3', {
artist: 'Usher feat. Lil\' Jon, Ludacris',
title: 'Yeah!'
}, (error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
API.uploadVideo('test.webm', {
name: '.webm'
}, (error, response, upload) => {
if (error) {
return console.log(error)
}
console.log(response)
upload(console.log)
}
API.uploadDocs('test.txt', {
group_id: -123396984,
title: 'Text file',
tags: 'test, text, txt'
}, (error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
API.uploadWallDocs('test.txt', {
group_id: -123396984,
title: 'Text file',
tags: 'test, text, txt'
}, (error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
API.uploadMessagesDocs('test.opus', {
peer_id: 168557207,
title: 'audio_message.opus',
type: 'audio_message'
}, (error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
API.uploadOwnerCoverPhoto('cover.png', {
group_id: 123396984
})
id (ing) - идентификатор сообщенияflags (int) - флаги сообщенияpeer_id (int) - адресатts (int) - время UNIX timestamptext (string) - текст сообщенияattachments (object) - вложения сообщенияrandom_id (int) - значение random_id, переданное отправителемsender_id (int) - иднтификатор отправителяout (bool) - флаг исходящего сообщенияread() // пометить сообщение как прочитанное
delete() // удалить сообщение
spam() // пометить сообщение как спам
restore() // восстановить удалённое сообщение (можно в течение 5 часов после удаления)
flag(flag) // проверка флага сообщения
getMedia(callback) // получение подробного объекта вложений сообщения
flag (int) - флаг (объект: LP_MESSAGE_FLAGS, API.flags) (подробнее)callback (function) - callback-функция (по умолчанию дефолтный каллбек) для возврата статуса отправленияПримеы использования:
API.lp_message(message => {
if (!message.flag(API.flags.OUTBOX)) {
message.getMedia((error, response) => {
if (error) {
return console.log(error)
}
console.log(response)
})
}
})
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' } ] }
message(token)
token (int, string)// Задать текст сообщения
text(text, connect)
// Прикрепить изображения
photo(data...)
// Прикрепить видеозаписи
video(data...)
// Прикрепить аудизаписи
audio(data...)
// Прикрепить документы
doc(data...)
// Прикрепить голосовое сообщение (форматы: .ogg, .opus)
voice(data...)
// Прикрепить граффити (форматы: .jpg, .png, .gif)
graffiti(data...)
// Прикрепить запись на стене
wall(post...)
// Прикрепить товары
market(product...)
// Прикрепить геопозицию
geo(lat, long)
// Прикрепить сообщения
forward(message...)
// Отправить сообщение адресату
send(peer)
text (string) - текст сообщенияconnect (bool) - задание коннектацииdata (string, object) - путь к файлу на диске | URL | идентификатор в VK (переменное количество аргументов, каждое вложение заданного типа через запятую)post (string) - идентификатор поста в VKproduct (string) - идентификатор товара/магазина в VKlat (float) - шитора на картеlong (float) - долгота на картеpeer (int, object) - адресат (user_id для пользователя, 2e9+chat_id для беседы, -group_id для сообщества) в числовом формате, либо объект сообщения, содерржащий в себе параметр peer_idПример использования:
API.message()
.text('Test message')
.photo('../test.jpg', 'photo168557207_456255039')
.video('../test.webm')
.audio('../test.mp3')
.doc('../test.jpg')
.voice('../test.opus')
.graffiti('../test.png')
.wall('wall-47590230_48')
.market('product-13883743_256626')
.geo(15,15)
.forward(5918153, '5918009, 5916431', [5918409, 5918411, 5918412])
.send(168557207)
FAQs
VK API Library.
The npm package vkapi-lib receives a total of 3 weekly downloads. As such, vkapi-lib popularity was classified as not popular.
We found that vkapi-lib demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.
Security News
GitHub is susceptible to a CDN flaw that allows attackers to host malware on any public repository.