Методы ВКонтакте API
На этой странице находится список методов API для работы с данными ВКонтакте.
В отличии от официальной документации, на этом сайте вы можете задать вопрос касаемый конкретного метода, используя комментарии ВКонтакте на странице метода.
Если вам не понятно что-то в параметрах метода или не ясно как обработать ответ, то можете задавать вопрос в комментариях к методу. Если ваш вопрос относится к ВКонтакте API в целом, то задавайте свои вопросы на форуме о ВКонтакте API.
О расхождениях в документации и при работе с методами так же можно писать в комментариях.
Пользователи
- isAppUser – возвращает информацию о том, установил ли пользователь данное приложение.
- users.get – возвращает расширенную информацию о пользователях.
- users.search – возвращает список пользователей в соответствии с заданным критерием поиска.
- getUserBalance – возвращает баланс текущего пользователя в данном приложении.
- getUserSettings – возвращает настройки приложения текущего пользователя.
- likes.getList – возвращает список пользователей, которые добавили объект в список «Мне нравится».
Друзья
- friends.get – возвращает список id друзей пользователя.
- friends.getAppUsers – возвращает список id друзей пользователя, которые установили данное приложение.
- friends.getOnline - возвращает список id друзей пользователя, находящихся сейчас на сайте.
- friends.getMutual – возвращает список id общих друзей между парой пользователей.
- friends.areFriends – возвращает информацию о дружбе между двумя пользователями.
Группы
- groups.get – возвращает список групп пользователя.
- groups.getById – возвращает информацию о группах по их идентификаторам.
- groups.isMember – возвращает информацию о том, является ли пользователь участником группы.
- groups.getMembers – возвращает список участников группы.
- groups.search – осуществляет поиск групп по заданной подстроке.
Фотографии
- photos.getAlbums – возвращает список альбомов пользователя.
- photos.getAlbumsCount – возвращает количество альбомов пользователя.
- photos.get – возвращает список фотографий в альбоме.
- photos.getProfile – возвращает список фотографий со страницы пользователя.
- photos.getAll – возвращает все фотографии пользователя в антихронологическом порядке.
- photos.getById – возвращает информацию о фотографиях.
- photos.createAlbum – создает пустой альбом для фотографий.
- photos.editAlbum – обновляет данные альбома для фотографий.
- photos.edit – изменяет описание у выбранной фотографии.
- photos.move – переносит фотографию из одного альбома в другой.
- photos.makeCover – делает фотографию обложкой альбома.
- photos.reorderAlbums – меняет порядок альбома в списке альбомов пользователя.
- photos.reorderPhotos – меняет порядок фотографий в списке фотографий альбома.
- photos.getUploadServer – возвращает адрес сервера для загрузки фотографий.
- photos.save – сохраняет фотографии после успешной загрузки.
- photos.getProfileUploadServer – возвращает адрес сервера для загрузки фотографии на страницу пользователя.
- photos.saveProfilePhoto – сохраняет фотографию страницы пользователя после успешной загрузки.
- photos.getWallUploadServer - возвращает адрес сервера для загрузки фотографии в специальный альбом, предназначенный для фотографий со стены.
- photos.saveWallPhoto - сохраняет фотографию после успешной загрузки.
Стена
- wall.get – возвращает список записей со стены.
- wall.getComments – получает комментарии к записи на стене пользователя.
- wall.getById – получает записи со стен пользователей по их идентификаторам.
- wall.post – добавляет запись на стену.
Новости
- newsfeed.get – возвращает ленту новостей для текущего пользователя.
- newsfeed.search – осуществляет поиск по новостям.
Оповещения об ответах
- notifications.get – возвращает список оповещений об ответах текущему пользователю.
- notifications.markAsViewed – сбрасывает счетчик новых оповещений.
Аудиозаписи
- audio.get – возвращает список аудиозаписей пользователя или группы.
- audio.getById – возвращает информацию об аудиозаписях по их идентификаторам.
- audio.getCount – возвращает количество аудиозаписей пользователя или группы.
- audio.getLyrics - возвращает текст аудиозаписи.
- audio.getUploadServer – возвращает адрес сервера для загрузки аудиозаписей.
- audio.save – сохраняет аудиозаписи после успешной загрузки.
- audio.search – осуществляет поиск по аудиозаписям.
- audio.add – копирует существующую аудиозапись на страницу пользователя или группы.
- audio.delete – удаляет аудиозапись со страницы пользователя или группы.
- audio.edit – редактирует аудиозапись пользователя или группы.
- audio.restore – восстанавливает удаленную аудиозапись пользователя или группы.
- audio.reorder – изменяет порядок аудиозаписи в списке аудиозаписей пользователя.
- audio.getAlbums – возвращает альбомы аудиозаписей пользователя или группы.
- audio.addAlbum – создает альбом аудиозаписей пользователя или группы.
- audio.editAlbum – изменяет название альбома аудиозаписей пользователя или группы.
- audio.deleteAlbum – удаляет альбом аудиозаписей пользователя или группы.
- audio.moveToAlbum – перемещает в альбом аудиозаписи пользователя или группы.
Видеозаписи
- video.get – Возвращает информацию о видеозаписях.
- video.edit – редактирует данные видеозаписи на странице пользователя.
- video.add – копирует видеозапись на страницу пользователя.
- video.delete – удаляет видеозапись со страницы пользователя.
- video.search – возвращает список видеозаписей в соответствии с заданным критерием поиска.
- video.getUserVideos – возвращает список видеозаписей, на которых отмечен пользователь.
- video.getComments – возвращает список комментариев к видеозаписи.
- video.createComment – создает новый комментарий к видеозаписи.
- video.editComment – изменяет текст комментария к видеозаписи.
- video.deleteComment – удаляет комментарий к видеозаписи.
- video.getTags – возвращает список отметок на видеозаписи.
- video.putTag – добавляет отметку на видеозапись.
- video.removeTag – удаляет отметку с видеозаписи.
- video.save – возвращает данные, необходимые для загрузки видеозаписей, а также данные видеозаписи.
- video.getAlbums – возвращает альбомы видеозаписей пользователя или группы.
- video.addAlbum – создает альбом видеозаписей пользователя или группы.
- video.editAlbum – изменяет название альбома видеозаписей пользователя или группы.
- video.deleteAlbum – удаляет альбом видеозаписей пользователя или группы.
- video.moveToAlbum – перемещает в альбом видеозаписи пользователя или группы.
Документы
- docs.get – Возвращает информацию о документах текущего пользователя или группы.
- docs.getById – Возвращает информацию о документах текущего пользователя по их id.
- docs.getUploadServer – возвращает адрес сервера для загрузки документов.
- docs.getWallUploadServer – возвращает адрес сервера для загрузки документов и последующей отправки их на стену.
- docs.delete – Удаляет документ пользователя или группы.
- docs.save – Cохраняет загруженные документы.
Геолокация
- places.add – создает новое место.
- places.getById – возвращает информацию о местах.
- places.search – возвращает список найденных мест.
- places.checkin – отмечает пользователя в указанном месте.
- places.getCheckins – возвращает список отметок.
- places.getTypes – возвращает список типов мест.
- places.getCountries – возвращает список стран.
- places.getCities – возвращает список городов.
- places.getRegions – возвращает список регионов.
- places.getCountryById – возвращает информацию о странах по их id.
- places.getCityById – возвращает информацию о городах по их id.
- places.getStreetById – возвращает информацию об улицах по их id.
Методы, требующие наличия стороннего сервера
- secure.sendNotification – отправляет уведомление пользователю.
- secure.getAppBalance – возвращает платежный баланс приложения.
- secure.getBalance – возвращает баланс пользователя на счету приложения.
- secure.withdrawVotes – списывает голоса со счета пользователя на счет приложения.
- secure.getTransactionsHistory – возвращает историю транзакций внутри приложения.
- secure.addRating – поднимает пользователю рейтинг от имени приложения.
- secure.setCounter – устанавливает счетчик, который выводится пользователю жирным шрифтом в левом меню, если он добавил приложение в левое меню.
- secure.setUserLevel – устанавливает уровень пользователя в приложении.
- secure.getUserLevel – получает уровень пользователя в приложении.
Методы для отправки и приема SMS
- secure.getSMSHistory – возвращает список SMS-уведомлений, отосланных приложением.
- secure.sendSMSNotification – отправляет SMS-уведомление на телефон пользователя.
- secure.getSMS - возвращает тексты SMS, полученные от пользователей приложения.
- setSMSPrefix - устанавливает префикс для приема SMS.
- getSMSPrefix - возвращает префикс для приема SMS.
Методы для хранения произвольных данных
- storage.get – возвращает значение хранимой переменной.
- storage.set – сохраняет значение хранимой переменной.
Другие методы
- execute - позволяет исполнять алгоритмы в API.
- getServerTime – возвращает текущее время.
- setNameInMenu – устанавливает короткое название приложения в левом меню, если пользователь добавил туда приложение.
Методы работы с заметками
- notes.get – возвращает список заметок пользователя.
- notes.getById – возвращает текущую заметку пользователя.
- notes.getFriendsNotes – возвращает список заметок друзей пользователя.
- notes.add – создаёт новую заметку
- notes.edit – редактирует заметку пользователя
- notes.delete – удаляет заметку пользователя
- notes.getComments – возвращает список комментариев к заметке.
- notes.createComment – добавляет новый комментарий к заметке.
- notes.editComment – изменяет текст комментария к заметке.
- notes.deleteComment – удаляет комментарий у заметки.
- notes.restoreComment – восстанавливает комментарий у заметки.
Методы работы с вики-страницами
- pages.get – возвращает вики-страницу.
- pages.save – сохраняет текст вики-страницы.
- pages.saveAccess – сохраняет настройки доступа вики-страницы.
- pages.getVersion – возвращает старую версию вики-страницы.
- pages.getHistory – возвращает список всех старых версий вики-страницы.
- pages.getTitles – возвращает список вики-страниц в группе.
- pages.parseWiki – возвращает html-представление wiki-разметки.
Статистика
- stats.get – возвращает статистику группы или приложения.
Устаревшие методы
- getUserInfo – возвращает краткую информацию о текущем пользователе.
- getUserInfoEx – возвращает расширенную информацию о текущем пользователе.
- activity.get – возвращает последнюю запись пользователя с собственной стены.
- activity.set – добавляет сообщение на стену текущего пользователя.
- activity.getHistory – возвращает записи пользователя, написанные им на своей стене.
- activity.getNews – возвращает обновления записей пользователей на собственных стенах.
- secure.saveAppStatus – сохраняет строку статуса приложения для последующего вывода в общем списке приложений на странице пользоваетеля.
- secure.getAppStatus – возвращает строку статуса приложения, сохранённую при помощи secure.saveAppStatus.
- getVariable – возвращает значение хранимой переменной.
- getVariables – возвращает значения нескольких переменных.
- putVariable – записывает значение переменной.
- getHighScores – возвращает таблицу рекордов.
- setUserScore – записывает результат текущего пользователя в таблицу рекордов.
- getMessages – возвращает список очереди сообщений.
- sendMessage – ставит сообщение в очередь.
- getGroups – возвращает список id групп, в которых состоит текущий пользователь.
- getGroupsFull – возвращает базовую информацию о группах, в которых состоит текущий пользователь.
Подписки
- subscriptions.get – возвращает список подписок пользователя.
- subscriptions.getFollowers – возвращает список подписчиков пользователя.
Расширенные методы API
Ниже приведен список расширенных методов для работы с личными сообщениями, стеной и фотографиями пользователя. Доступ к этим методам ограничен и предоставляется только для Desktop/Mobile-приложений.
Личные сообщения
- messages.get – возвращает список входящих либо исходящих сообщений текущего пользователя.
- messages.getById – возвращает сообщения по их ID.
- messages.getDialogs – возвращает список диалогов текущего пользователя.
- messages.search – возвращает найденные сообщения текущего пользователя по введенной строке поиска.
- messages.send – посылает сообщение.
- messages.delete – удаляет сообщение.
- messages.deleteDialog – Удаляет все сообщения в диалоге,
- messages.restore – восстанавливает только что удаленное сообщение.
- messages.markAsNew – помечает сообщения как непрочитанные.
- messages.markAsRead – помечает сообщения как прочитанные.
- messages.getHistory – возвращает историю сообщений для данного пользователя.
- messages.getLongPollServer – возвращает данные, необходимые для подключения к LongPoll серверу
Стена
- wall.post – добавляет запись на стену.
- wall.delete – удаляет запись со стены.
- wall.restore – восстанавливает удаленную со стены запись.
- wall.addComment – добавляет комментарий к записи на стене пользователя.
- wall.deleteComment – удаляет комментарий к записи на стене полльзователя.
- wall.restoreComment – восстанавливает комментарий к записи на стене пользователя.
- wall.addLike – добавляет запись на стене пользователя в список Мне нравится.
- wall.deleteLike – удаляет запись на стене пользователя из списка Мне нравится.
Фотографии
- photos.getComments – возвращает список комментариев к фотографии.
- photos.getAllComments – возвращает список комментариев к альбому или ко всем альбомам.
- photos.createComment – создает новый комментарий к фотографии.
- photos.editComment – изменяет текст комментария к фотографии.
- photos.deleteComment – удаляет комментарий к фотографии.
- photos.restoreComment – восстанавливает комментарий к фотографии.
- photos.getUserPhotos – возвращает список фотографий, на которых отмечен пользователь.
- photos.getTags – возвращает список отметок на фотографии.
- photos.putTag – добавляет отметку на фотографию.
- photos.removeTag – удаляет отметку с фотографии.
- photos.deleteAlbum – удаляет фотоальбом пользователя.
- photos.getMessagesUploadServer – возвращает адрес сервера для загрузки фотографии в качестве прикрепления к личному сообщению.
- photos.saveMessagesPhoto – сохраняет фотографию после загрузки.
- photos.delete – удаляет фотографию.
Новости
- newsfeed.getBanned – возвращает список скрытых пользователей и групп в новостях.
- newsfeed.addBan – запрещает показывать новости от заданных пользователей и групп.
- newsfeed.deleteBan – разрешает показывать новости от заданных пользователей и групп.
Мне нравится
- likes.add – добавляет объект в список «Мне нравится» текущего пользователя.
- likes.delete – удаляет объект из списка «Мне нравится» текущего пользователя.
- likes.getList – возвращает список пользователей, которые добавили объект в список «Мне нравится».
- likes.isLiked – проверяет находится ли объектов списке «Мне нравится».
Статус
- status.get – получает статус пользователя.
- status.set – устанавливает статус текущего пользователя.
Друзья
- friends.getLists – возвращает информацию о списках друзей.
- friends.addList – создаёт новый список друзей.
- friends.editList – редактирует существующий список друзей.
- friends.add – добавляет пользователя в друзья или одобряет заявку на добавление.
- friends.delete – удаляет пользователя из друзей или отклоняет заявку на добавление.
- friends.getRequests – возвращает список заявок в друзья у текущего пользователя.
Опросы
- polls.getById – возвращает детальную информацию об опросе.
- polls.addVote – добавляет голос текущего пользователя к выбранному варианту ответа.
- polls.deleteVote – снимает голос текущего пользователя с выбранного варианта ответа.
Подписки
- subscriptions.follow – добавляет указанного пользователя в список подписок текущего пользователя.
- subscriptions.unfollow – удаляет указанного пользователя из списка подписок текущего пользователя.