vk_maria.api.Vk

class Vk(access_token, api_version='5.126')

Базовые классы: object

Читайте подробнее про методы https://vk.com/dev/methods

Параметры:

• access_token (str) – Токен сообщества

• api_version (str, default: '5.126') – Версия Api

Methods

board_delete_comment	type topic_id: int
board_restore_comment	type topic_id: int
docs_get_messages_upload_server	type peer_id: int
docs_get_wall_upload_server
docs_save	type file:
docs_search	type q: str
groups_add_address	type title: str
groups_delete_address	type address_id: int
groups_disable_online
groups_edit	type title: Optional[str], default: None
groups_edit_address	type address_id: int
groups_enable_online
groups_get_banned	type fields: Optional[List[str]], default: None
groups_get_by_id	type fields: Optional[List[str]], default: None
groups_get_longpoll_server
groups_get_members	type sort: str, default: 'id_asc'
groups_get_online_status
groups_get_token_permissions
groups_is_member	type user_id: Optional[int], default: None
groups_set_settings	type messages: Optional[int], default: None
market_edit_order	type user_id: int
market_get_group_orders	type offset: Optional[int], default: None
market_get_order_by_id	type order_id: int
market_get_order_items	type order_id: int
messages_create_chat	type user_ids: List[int]
messages_delete	type message_ids: Optional[List[int]], default: None
messages_delete_chat_photo	type chat_id: int
messages_delete_conversation	type user_id: Optional[int], default: None
messages_edit	type peer_id: int
messages_edit_chat	type chat_id: int
messages_get_by_conversation_message_id	type peer_id: int
messages_get_by_id	type message_ids: List[int]
messages_get_conversation_members	type peer_id: int
messages_get_conversations	type offset: int, default: 0
messages_get_conversations_by_id	type peer_ids: List[int]
messages_get_history	type offset: Optional[int], default: None
messages_get_history_attachments	type peer_id: int
messages_get_important_messages	type count: int, default: 20
messages_get_intent_users	type intent: str
messages_get_invite_link	type peer_id: int
messages_get_longpoll_history	type ts: int
messages_get_longpoll_server	type need_pts: Optional[int], default: None
messages_is_messages_from_group_allowed	type user_id: int
messages_mark_as_answered_conversation	type peer_id: int
messages_mark_as_important_conversation	type peer_id: int
messages_mark_as_read	type message_ids: Optional[List[int]], default: None
messages_pin	type peer_id: int
messages_remove_chat_user	type chat_id: int
messages_restore	type message_id: int
messages_search	type q: Optional[str], default: None
messages_search_conversations	type q: str
messages_send	type user_id: Optional[int], default: None
messages_send_message_event_answer	type event_id: str
messages_set_activity	type user_id: int
messages_set_chat_photo	type file: str
messages_unpin	type peer_id: int
photos_get_chat_upload_server	type chat_id: int
photos_get_messages_upload_server
photos_get_owner_cover_photo_upload_server	type crop_x: Optional[float], default: None
photos_save_messages_photo	type photo: str
photos_save_owner_cover_photo	type hash: str
podcasts_search_podcast	type search_string: str
storage_get	type key: Optional[str], default: None
storage_get_keys	type user_id: int
storage_set	type key: str
stories_delete	type owner_id: int
stories_get	type owner_id: int
stories_get_by_id	type stories: List[int]
stories_get_photo_upload_server	type add_to_news: Optional[int], default: None
stories_get_replies	type owner_id: int
stories_get_stats	type owner_id: int
stories_get_video_upload_server	type user_ids: Optional[List[int]], default: None
stories_get_viewers	type owner_id: int
stories_hide_all_replies	type owner_id: int
stories_hide_reply	type owner_id: int
stories_save	type upload_results: List[str]
users_get	type user_ids: List[int]
utils_check_link	type url: str
utils_get_link_stats	type key: str
utils_get_server_time	Возвращает число, соответствующее времени в UnixTime.
utils_get_short_link	type url: str
utils_resolve_screen_name	type screen_name: str
wall_close_comments	param owner_id:
wall_create_comment	type post_id: int

messages_create_chat(user_ids, title)

Параметры:

• user_ids (List[int]) – Идентификаторы пользователей, которых нужно включить в мультидиалог.

• title (str) – Название беседы.

messages_delete(message_ids=None, peer_id=None, spam=None, delete_for_all=None, cmids=None)

Параметры:

• message_ids (Optional[List[int]], default: None) – Список идентификаторов сообщений.

• spam (Optional[int], default: None) – Помечает сообщения как спам.

• delete_for_all (Optional[int], default: None) – Удаление для всех.

• cmids (Optional[List[int]], default: None) – Conversation Message Ids

• peer_id (Optional[int], default: None) –

messages_delete_chat_photo(chat_id)

Параметры:

chat_id (int) – Идентификатор беседы.

messages_delete_conversation(user_id=None, peer_id=None)

Параметры:

• user_id (Optional[int], default: None) – Идентификатор пользователя. Если требуется очистить историю беседы, используйте peer_id.

• peer_id (Optional[int], default: None) – Идентификатор назначения.

messages_edit(peer_id, message=None, lat=None, long=None, attachment=None, keep_forward_messages=None, keep_snippets=None, dont_parse_links=None, message_id=None, conversation_message_id=None, template=None, keyboard=None)

Параметры:

• peer_id (int) – Идентификатор назначения.

• message (Optional[str], default: None) – Текст сообщения. Обязательный параметр, если не задан параметр attachment.

• lat (Optional[float], default: None) – Географическая широта (от -90 до 90).

• long (Optional[float], default: None) – Географическая долгота (от -180 до 180).

• attachment (default: None) – Медиавложения к личному сообщению, перечисленные через запятую.

• keep_forward_messages (Optional[int], default: None) – Сохранить прикреплённые пересланные сообщения.

• keep_snippets (Optional[int], default: None) – Сохранить прикреплённые внешние ссылки (сниппеты).

• dont_parse_links (Optional[int], default: None) – Не создавать сниппет ссылки из сообщения.

• message_id (Optional[int], default: None) – Идентификатор сообщения.

• conversation_message_id (Optional[int], default: None) – Идентификатор сообщения в беседе.

• template (default: None) – Объект, описывающий шаблоны сообщений.

• keyboard (default: None) – Объект, описывающий клавиатуру бота.

messages_edit_chat(chat_id, title)

Параметры:

• chat_id (int) – Идентификатор беседы.

• title (str) – Новое название для беседы.

messages_get_by_conversation_message_id(peer_id, conversation_message_ids, extended=None, fields=None)

Параметры:

• peer_id (int) – Идентификатор назначения.

• conversation_message_ids (List[int]) – Идентификаторы сообщений. Максимум 100 идентификаторов.

• extended (Optional[int], default: None) – Возвращать дополнительные поля.

• fields (Optional[List[str]], default: None) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

messages_get_by_id(message_ids, preview_length=None, extended=None, fields=None)

Параметры:

• message_ids (List[int]) – Идентификаторы сообщений. Максимум 100 идентификаторов.

• preview_length (Optional[int], default: None) – Количество символов, по которому нужно обрезать сообщение.

• extended (Optional[int], default: None) – Возвращать дополнительные поля.

• fields (Optional[List[str]], default: None) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

messages_get_conversation_members(peer_id, fields)

Параметры:

• peer_id (int) – Идентификатор назначения.

• fields (List[str]) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

messages_get_conversations(offset=0, count=20, filter='all', extended=None, start_message_id=None, fields=None)

Параметры:

• offset (int, default: 0) – Cмещение, необходимое для выборки определенного подмножества результатов.

• count (int, default: 20) – Максимальное число результатов, которые нужно получить.

• filter (str, default: 'all') – Фильтр. Возможные значения: all, unread, important, unanswered.

• extended (Optional[int], default: None) – Возвращать дополнительные поля.

• start_message_id (Optional[int], default: None) – Идентификатор сообщения, начиная с которого нужно возвращать беседы.

• fields (Optional[List[str]], default: None) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

messages_get_conversations_by_id(peer_ids, extended=None, fields=None)

Параметры:

• peer_ids (List[int]) – Идентификаторы назначений.

• extended (Optional[int], default: None) – Возвращать дополнительные поля.

• fields (Optional[List[str]], default: None) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

messages_get_history(offset=None, count=20, user_id=None, peer_id=None, start_message_id=None, rev=None, extended=None, fields=None)

Параметры:

• offset (Optional[int], default: None) – Cмещение, необходимое для выборки определенного подмножества сообщений

• count (int, default: 20) – Количество сообщений, которое необходимо получить (но не более 200)

• user_id (Optional[int], default: None) – Идентификатор пользователя, историю переписки с которым необходимо вернуть.

• peer_id (Optional[int], default: None) – Идентификатор назначения.

• start_message_id (Optional[int], default: None) – Идентификатор сообщения, начиная с которого нужно возвращать беседы.

• rev (Optional[int], default: None) – Возвращать сообщения в хронологическом порядке (по умолчанию).

• extended (Optional[int], default: None) – Возвращать дополнительные поля.

• fields (Optional[List[str]], default: None) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

messages_get_history_attachments(peer_id, media_type=None, start_from=None, count=20, photo_sizes=None, fields=None, preserve_order=None, max_forwards_level=45)

Параметры:

• peer_id (int) – Идентификатор назначения.

• media_type (Optional[List[str]], default: None) – Тип материалов, который необходимо вернуть.

• start_from (str | None) –

• count (int) –

• photo_sizes (int | None) –

• fields (List[str] | None) –

• preserve_order (int | None) –

• max_forwards_level (int) –

Доступные значения: photo, video, audio, doc, link, market, wall, share.

Параметры:

• start_from (Optional[str], default: None) – Смещение, необходимое для выборки определенного подмножества объектов.

• count (int, default: 20) – Количество объектов, которое необходимо получить (но не более 200).

• photo_sizes (Optional[int], default: None) – Параметр, указывающий нужно ли возвращать ли доступные размеры фотографии в специальном формате.

• fields (Optional[List[str]], default: None) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

• preserve_order (Optional[int], default: None) – Параметр, указывающий нужно ли возвращать вложения в оригинальном порядке.

• max_forwards_level (int, default: 45) – Максимальная глубина вложенности пересланных сообщений.

• peer_id (int) –

• media_type (List[str] | None) –

messages_get_important_messages(count=20, offset=None, start_message_id=None, preview_length=None, fields=None, extended=None)

Параметры:

• count (int, default: 20) – Максимальное число результатов, которые нужно получить.

• offset (Optional[int], default: None) – Смещение, необходимое для выборки определенного подмножества результатов.

• start_message_id (Optional[int], default: None) – Идентификатор сообщения, начиная с которого нужно возвращать список.

• preview_length (Optional[int], default: None) –

• fields (Optional[List[str]], default: None) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

• extended (Optional[int], default: None) – Возвращать дополнительные поля.

messages_get_intent_users(intent, subscribe_id=None, offset=None, count=20, extended=None, name_case=None, fields=None)

Параметры:

• intent (str) – Тип интента, который требует подписку.

• subscribe_id (Optional[int], default: None) – ID подписки, необходимый для confirmed_notification.

• offset (Optional[int], default: None) – Смещение, необходимое для выборки определенного подмножества.

• count (int, default: 20) – Количество подписчиков, информацию о которых необходимо получить.

• extended (Optional[int], default: None) – Возвращать дополнительные поля.

• name_case (Optional[List[str]], default: None) – падеж для склонения имени и фамилии пользователя.

• fields (List[str] | None) –

Возможные значения: именительный – nom, родительный – gen, дательный – dat, винительный – acc, творительный – ins, предложный – abl. По умолчанию nom.

Параметры:

• fields (Optional[List[str]], default: None) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

• intent (str) –

• subscribe_id (int | None) –

• offset (int | None) –

• count (int) –

• extended (int | None) –

• name_case (List[str] | None) –

messages_get_invite_link(peer_id, reset=None)

Параметры:

• peer_id (int) – Идентификатор назначения.

• reset (Optional[int], default: None) – Сгенерировать новую ссылку, сбросив предыдущую.

messages_get_longpoll_history(ts, pts, preview_length=None, onlines=None, fields=None, events_limit=1000, msgs_limit=200, max_msg_id=None, lp_version=3, last_n=0, credentials=None)

Параметры:

• ts (int) – Последнее значение параметра ts.

• pts (int) – последнее значение параметра new_pts.

• preview_length (Optional[int], default: None) – Количество символов, по которому нужно обрезать сообщение.

• onlines (Optional[int], default: None) – Возвращать в числе прочих события 8 и 9 (пользователь стал онлайн/оффлайн).

• fields (Optional[List[str]], default: None) – Список дополнительных полей профилей, которые необходимо вернуть.

• events_limit (int, default: 1000) – Лимит по количеству всех событий в истории.

• msgs_limit (int) –

• max_msg_id (int | None) –

• lp_version (int) –

• last_n (int) –

• credentials (int | None) –

Обратите внимание, параметры events_limit и msgs_limit применяются совместно. Число результатов в ответе ограничивается первым достигнутым лимитом.

Параметры:

• msgs_limit (int, default: 200) – Лимит по количеству событий с сообщениями в истории.

• max_msg_id (Optional[int], default: None) – Максимальный идентификатор сообщения среди уже имеющихся в локальной копии.

• lp_version (int, default: 3) – Версия Long Poll.

• last_n (int, default: 0) –

• credentials (Optional[int], default: None) –

• ts (int) –

• pts (int) –

• preview_length (int | None) –

• onlines (int | None) –

• fields (List[str] | None) –

• events_limit (int) –

messages_get_longpoll_server(need_pts=None, lp_version=3)

Параметры:

• need_pts (Optional[int], default: None) – Возвращать поле pts, необходимое для работы метода messages.getLongPollHistory.

• lp_version (int, default: 3) – Версия Long Poll.

messages_is_messages_from_group_allowed(user_id)

Параметры:

user_id (int) – Идентификатор пользователя.

messages_mark_as_answered_conversation(peer_id, answered=1)

Параметры:

• peer_id (int) – Идентификатор беседы.

• answered (int, default: 1) – Беседа отмечена отвеченной.

messages_mark_as_important_conversation(peer_id, important=1)

Параметры:

• peer_id (int) – Идентификатор беседы

• important (int, default: 1) – Если сообщения необходимо пометить, как важные.

messages_mark_as_read(message_ids=None, peer_id=None, start_message_id=None, mark_conversation_as_read=None)

Параметры:

• message_ids (Optional[List[int]], default: None) – Идентификаторы сообщений.

• peer_id (Optional[str], default: None) – Идентификатор назначения.

• start_message_id (Optional[int], default: None) – При передаче этого параметра будут помечены как прочитанные все сообщения, начиная с данного.

• mark_conversation_as_read (Optional[int], default: None) –

messages_pin(peer_id, message_id, conversation_message_id)

Параметры:

• peer_id (int) – Идентификатор назначения.

• message_id (int) – Идентификатор сообщения, которое нужно закрепить.

• conversation_message_id (int) – Идентификатор сообщения беседы, которое нужно закрепить.

messages_remove_chat_user(chat_id, user_id=None, member_id=None)

Параметры:

• chat_id (int) – Идентификатор беседы.

• user_id (Optional[int], default: None) – Идентификатор пользователя, которого необходимо исключить из беседы.

• member_id (Optional[int], default: None) – Идентификатор участника, которого необходимо исключить из беседы.

Для сообществ — идентификатор сообщества со знаком «минус».

messages_restore(message_id)

Параметры:

message_id (int) – Идентификатор сообщения, которое нужно восстановить.

messages_search(q=None, peer_id=None, date=None, preview_length=0, offset=None, count=20, extended=None, fields=None)

Параметры:

• q (Optional[str], default: None) – Подстрока, по которой будет производиться поиск.

• peer_id (Optional[int], default: None) – Фильтр по идентификатору назначения для поиска по отдельному диалогу.

• date (Optional[int], default: None) – Дата в формате DDMMYYYY. Если параметр задан, в ответе будут только сообщения, отправленные до указанной даты.

• preview_length (int, default: 0) – Количество символов, по которому нужно обрезать сообщение.

• offset (Optional[int], default: None) – Смещение, необходимое для выборки определенного подмножества сообщений из списка найденных.

• count (int, default: 20) – Количество сообщений, которое необходимо получить.

• extended (Optional[int], default: None) – Возвращать дополнительные поля для пользователей и сообществ.

• fields (Optional[List[str]], default: None) – Список ыудополнительных полей для пользователей и сообществ.

messages_search_conversations(q, count=20, extended=None, fields=None)

Параметры:

• q (str) – Поисковой запрос.

• count (int, default: 20) – Максимальное число результатов для получения.

• extended (Optional[int], default: None) – Возвращать дополнительные поля.

• fields (Optional[List[str]], default: None) – Дополнительные поля пользователей и сообществ, которые необходимо вернуть в ответе.

messages_send(user_id=None, peer_id=None, peer_ids=None, domain=None, chat_id=None, message=None, lat=None, long=None, attachment=None, reply_to=None, forward_messages=None, forward=None, sticker_id=None, keyboard=None, template=None, payload=None, content_source=None, dont_parse_links=None, disable_mentions=None, intent='default', subscribe_id=None)

Параметры:

• user_id (Optional[int], default: None) – Идентификатор пользователя, которому отправляется сообщение.

• peer_id (Optional[int], default: None) – Идентификатор назначения.

• peer_ids (Optional[List[int]], default: None) – Идентификаторы получателей сообщения (при необходимости отправить сообщение сразу нескольким пользователям)

• domain (Optional[str], default: None) – Короткий адрес пользователя.

• chat_id (Optional[int], default: None) – Идентификатор беседы, к которой будет относиться сообщение.

• message (Optional[str], default: None) – Текст личного сообщения. Обязательный параметр, если не задан параметр attachment.

• lat (Optional[float], default: None) – Географическая широта (от -90 до 90).

• long (Optional[float], default: None) – Географическая долгота (от -180 до 180).

• attachment (default: None) – Медиавложения к личному сообщению, перечисленные через запятую.

• reply_to (Optional[int], default: None) – Идентификатор сообщения, на которое требуется ответить.

• forward_messages (Optional[List[int]], default: None) – Идентификаторы пересылаемых сообщений.

• forward (default: None) – JSON-объект.

• sticker_id (Optional[int], default: None) – Идентификатор стикера.

• keyboard (default: None) – Объект, описывающий клавиатуру бота.

• template (Optional[Dict], default: None) – Объект, описывающий шаблон сообщения.

• payload (default: None) – Полезная нагрузка.

• content_source (Optional[Dict], default: None) – Объект, описывающий источник пользовательского контента для чат-ботов.

• dont_parse_links (Optional[int], default: None) – Не создавать сниппет ссылки из сообщения.

• disable_mentions (Optional[int], default: None) – Отключить уведомление об упоминании в сообщении.

• intent (str, default: 'default') – Строка, описывающая интенты.

• subscribe_id (Optional[int], default: None) –

messages_send_message_event_answer(event_id, user_id, peer_id, event_data=None)

Параметры:

• event_id (str) – Случайная строка, которая возвращается в событии message_event.

• user_id (int) – Идентификатор пользователя.

• peer_id (int) – Идентификатор диалога со стороны сообщества.

• event_data (default: None) – Объект действия, которое должно произойти после нажатия на кнопку.

messages_set_activity(user_id, type, peer_id)

Параметры:

• user_id (int) – Идентификатор пользователя.

• type (str) – typing — пользователь начал набирать текст, audiomessage — пользователь записывает голосовое сообщение.

• peer_id (int) – Идентификатор назначения.

messages_set_chat_photo(file)

Параметры:

file (str) – Содержимое поля response из ответа специального upload сервера, полученного в результате загрузки изображения на адрес, полученный методом photos.getChatUploadServer.

messages_unpin(peer_id)

Параметры:

peer_id (int) – Идентификатор назначения.

groups_add_address(title, address, country_id, city_id, latitude, longitude, metro_id=None, additional_address=None, phone=None, work_info_status=None, timetable=None, is_main_address=None)

Параметры:

• title (str) – Заголовок адреса.

• address (str) – Строка адреса.

• additional_address (Optional[str], default: None) – Дополнительное описание адреса.

• country_id (int) – Идентификатор страны.

• city_id (int) – Идентификатор города.

• latitude (float) – Географическая широта отметки, заданная в градусах (от -90 до 90).

• longitude (float) – Географическая долгота отметки, заданная в градусах (от -180 до 180)

• metro_id (Optional[int], default: None) – Идентификатор станции метро.

• phone (Optional[str], default: None) – Номер телефона.

• work_info_status (Optional[str], default: None) – тип расписания. Возможные значения: no_information – нет информации о расписании; temporarily_closed — временно закрыто; always_opened — открыто круглосуточно; forever_closed — закрыто навсегда; timetable — открыто в указанные часы работы. Для этого типа расписания необходимо передать параметр timetable;

• timetable (default: None) –

• is_main_address (Optional[int], default: None) – Установить адрес основным.

groups_delete_address(address_id)

Параметры:

address_id (int) – Идентификатор адреса.

groups_disable_online()

groups_edit(title=None, description=None, screen_name=None, access=None, website=None, subject=None, email=None, phone=None, rss=None, event_start_date=None, event_finish_date=None, event_group_id=None, public_category=None, public_subcategory=None, public_date=None, wall=None, topics=None, photos=None, video=None, audio=None, links=None, events=None, places=None, contacts=None, docs=None, wiki=None, messages=None, articles=None, addresses=None, age_limits=None, market=None, market_comments=None, market_country=None, market_city=None, market_currency=None, market_contact=None, market_wiki=None, obscene_filter=None, obscene_stopwords=None, obscene_words=None, main_section=None, secondary_section=None, country=None, city=None)

Параметры:

• title (Optional[str], default: None) – Название сообщества.

• description (Optional[str], default: None) – Описание сообщества.

• screen_name (Optional[str], default: None) – Короткое имя сообщества.

• access (Optional[int], default: None) – тип группы. Возможные значения: 0 – открытая; 1 – закрытая; 2 – частная;

• website (Optional[str], default: None) – Адрес сайта, который будет указан в информации о группе.

• subject (Optional[int], default: None) – Тематика сообщества.

• email (Optional[str], default: None) – Электронный адрес организатора (для мероприятий).

• phone (Optional[str], default: None) – Номер телефона организатора (для мероприятий).

• rss (Optional[str], default: None) – Адрес rss для импорта новостей

• event_start_date (Optional[int], default: None) – Дата начала события.

• event_finish_date (Optional[int], default: None) – Дата окончания события.

• event_group_id (Optional[int], default: None) – идентификатор группы, которая является организатором события (только для событий).

• public_category (Optional[int], default: None) – Категория публичной страницы.

• public_subcategory (Optional[int], default: None) – Подкатегория публичной станицы.

• public_date (Optional[str], default: None) – дата основания компании, организации, которой посвящена публичная страница в виде строки формата «dd.mm.YYYY».

• wall (Optional[int], default: None) – Стена. Возможные значения: 0 — выключена; 1 — открытая; 2 — ограниченная (доступно только для групп и событий); 3 — закрытая (доступно только для групп и событий).

• topics (Optional[int], default: None) – Обсуждения. Возможные значения: 0 — выключены; 1 — открытые; 2 — ограниченные (доступно только для групп и событий).

• photos (Optional[int], default: None) – Фотографии. Возможные значения: 0 — выключены; 1 — открытые; 2 — ограниченные (доступно только для групп и событий).

• video (Optional[int], default: None) – Видеозаписи. Возможные значения: 0 — выключены; 1 — открытые; 2 — ограниченные (доступно только для групп и событий).

• audio (Optional[int], default: None) – Аудиозаписи. Возможные значения: 0 — выключены; 1 — открытые; 2 — ограниченные (доступно только для групп и событий).

• links (Optional[int], default: None) – Ссылки (доступно только для публичных страниц). Возможные значения: 0 — выключены; 1 — включены.

• events (Optional[int], default: None) – События (доступно только для публичных страниц). Возможные значения: 0 — выключены; 1 — включены.

• places (Optional[int], default: None) – Места (доступно только для публичных страниц). Возможные значения: 0 — выключены; 1 — включены.

• contacts (Optional[int], default: None) – Контакты (доступно только для публичных страниц). Возможные значения: 0 — выключены; 1 — включены.

• docs (Optional[int], default: None) – Документы сообщества. Возможные значения: 0 — выключены; 1 — открытые; 2 — ограниченные (доступно только для групп и событий).

• wiki (Optional[int], default: None) – wiki-материалы сообщества. Возможные значения: 0 — выключены; 1 — открытые; 2 — ограниченные (доступно только для групп и событий).

• messages (Optional[int], default: None) – Сообщения сообщества. Возможные значения: 0 — выключены; 1 — включены.

• articles (Optional[int], default: None) –

• addresses (Optional[int], default: None) –

• age_limits (Optional[int], default: None) – Возрастное ограничение для сообщества. Возможные значения: 1 — нет ограничений; 2 — 16+; 3 — 18+.

• market (Optional[int], default: None) – Товары. Возможные значения: 0 — выключены; 1 — включены.

• market_comments (Optional[int], default: None) – Комментарии к товарам. Возможные значения: 0 — выключены; 1 — включены.

• market_country (Optional[List[int]], default: None) – Регионы доставки товаров.

• market_city (Optional[List[int]], default: None) – Города доставки товаров (в случае если указана одна страна).

• market_currency (Optional[int], default: None) – Идентификатор валюты магазина. Возможные значения: 643 — российский рубль; 980 — украинская гривна; 398 — казахстанский тенге; 978 — евро; 840 — доллар США.

• market_contact (Optional[int], default: None) – Контакт для связи для продавцом.

• market_wiki (Optional[int], default: None) – Идентификатор wiki-страницы с описанием магазина.

• obscene_filter (Optional[int], default: None) – Фильтр нецензурных выражений в комментариях. Возможные значения: 0 — выключен; 1 — включен.

• obscene_stopwords (Optional[int], default: None) – Фильтр по ключевым словам в комментариях. Возможные значения: 0 — выключен; 1 — включен.

• obscene_words (Optional[List[str]], default: None) – Ключевые слова для фильтра комментариев.

• main_section (Optional[int], default: None) –

• secondary_section (Optional[int], default: None) –

• country (Optional[int], default: None) –

• city (Optional[int], default: None) –

groups_edit_address(address_id, title=None, address=None, additional_address=None, country_id=None, city_id=None, metro_id=None, latitude=None, longitude=None, phone=None, work_info_status=None, timetable=None, is_main_address=None)

Параметры:

• address_id (int) – Идентификатор адреса.

• title (Optional[str], default: None) – Заголовок адреса.

• address (Optional[str], default: None) – Строка адреса. Невский проспект, дом 28

• additional_address (Optional[str], default: None) – Дополнительное описание адреса.

• country_id (Optional[int], default: None) – Идентификатор страны.

• city_id (Optional[int], default: None) – Идентификатор города.

• metro_id (Optional[int], default: None) – Идентификатор станции метро.

• latitude (Optional[float], default: None) – Географическая широта отметки, заданная в градусах (от -90 до 90).

• longitude (Optional[float], default: None) – Географическая долгота отметки, заданная в градусах (от -180 до 180).

• phone (Optional[str], default: None) – Номер телефона.

• work_info_status (Optional[str], default: None) – Тип расписания.

• timetable (default: None) –

• is_main_address (Optional[int], default: None) – Установить адрес основным.

groups_enable_online()

groups_get_by_id(fields=None)

Параметры:

fields (Optional[List[str]], default: None) – Список дополнительных полей, которые необходимо вернуть.

groups_get_members(sort='id_asc', offset=0, count=1000, fields=None)

Параметры:

• sort (str, default: 'id_asc') – Сортировка, с которой необходимо вернуть список участников. Возможные значения: id_asc — в порядке возрастания id; id_desc — в порядке убывания id; time_asc — в хронологическом порядке по вступлению в сообщество; time_desc — в антихронологическом порядке по вступлению в сообщество.

• offset (int, default: 0) – Смещение, необходимое для выборки определенного подмножества участников.

• count (int, default: 1000) – Количество участников сообщества, информацию о которых необходимо получить.

• fields (Optional[List[str]], default: None) – Список дополнительных полей, которые необходимо вернуть.

groups_is_member(user_id=None, user_ids=None)

Параметры:

• user_id (Optional[int], default: None) – Идентификатор пользователя.

• user_ids (Optional[List[int]], default: None) – Идентификаторы пользователей, не более 500.

groups_get_banned(fields=None, count=20, owner_id=None, offset=None)

Параметры:

• fields (Optional[List[str]], default: None) – Смещение, необходимое для выборки определенного подмножества черного списка.

• count (int, default: 20) – Количество пользователей, которое необходимо вернуть.

• owner_id (Optional[int], default: None) – Идентификатор пользователя или сообщества из чёрного списка, информацию о котором нужно получить.

• offset (Optional[int], default: None) – Смещение, необходимое для выборки определенного подмножества черного списка.

groups_get_online_status()

groups_get_token_permissions()

groups_set_settings(messages=None, bots_capabilities=None, bots_start_button=None, bots_add_to_chat=None)

Параметры:

• messages (Optional[int], default: None) – Сообщения сообщества. Возможные значения: 0 — выключены; 1 — включены.

• bots_capabilities (Optional[int], default: None) – Возможности ботов (использование клавиатуры, добавление в беседу). Возможные значения: 0 — выключены; 1 — включены.

• bots_start_button (Optional[int], default: None) – Кнопка «Начать» в диалоге с сообществом. Работает, в случае если bots_capabilities=1. Возможные значения: 0 — выключена; 1 — включена.

• bots_add_to_chat (Optional[int], default: None) – Добавление бота в беседы. Работает, в случае если bots_capabilities=1. Возможные значения: 0 — запрещено; 1 — разрешено.

groups_get_longpoll_server()

board_delete_comment(topic_id, comment_id)

Параметры:

• topic_id (int) – Идентификатор обсуждения.

• comment_id (int) – Идентификатор комментария в обсуждении.

board_restore_comment(topic_id, comment_id)

Параметры:

• topic_id (int) – Идентификатор обсуждения.

• comment_id (int) – Идентификатор комментария.

docs_get_messages_upload_server(peer_id, type='doc')

Параметры:

• peer_id (int) – Идентификатор назначения.

• type (str, default: 'doc') – Тип документа. Возможные значения: doc — обычный документ; audio_message — голосовое сообщение;

docs_get_wall_upload_server()

docs_save(file, title=None, tags=None, return_tags=None)

Параметры:

• file – Параметр, возвращаемый в результате загрузки файла на сервер.

• title (Optional[str], default: None) – Название документа.

• tags (Optional[List[str]], default: None) – Метки для поиска.

• return_tags (Optional[int], default: None) –

docs_search(q, search_own=None, count=20, offset=None, return_tags=None)

Параметры:

• q (str) – Строка поискового запроса. Например, зеленые тапочки.

• search_own (Optional[int], default: None) – 1 — искать среди собственных документов пользователя.

• count (int, default: 20) – Количество документов, информацию о которых нужно вернуть.

• offset (Optional[int], default: None) – Смещение, необходимое для выборки определенного подмножества документов.

• return_tags (Optional[int], default: None) –

market_edit_order(user_id, order_id, merchant_comment=None, status=None, track_number=None, payment_status=None, delivery_price=None, width=None, length=None, height=None, weight=None, comment_for_user=None)

Параметры:

• user_id (int) – Идентификатор пользователя.

• order_id (int) – Идентификатор заказа.

• merchant_comment (Optional[str], default: None) – Комментарий продавца.

• status (Optional[int], default: None) –

  Статус заказа. Возможные значения:

  0 - новый; 1 - согласуется; 2 - собирается; 3 - доставляется; 4 - выполнен; 5 - отменен; 6 - возвращен.

• track_number (Optional[str], default: None) – Трек-номер.

• payment_status (Optional[str], default: None) –

  Статус платежа. Возможные значения:

  not_paid - не оплачен; paid - оплачен; returned - возвращен.

• delivery_price (Optional[int], default: None) – Стоимость доставки.

• width (Optional[float], default: None) – Ширина.

• length (Optional[float], default: None) – Длина.

• height (Optional[float], default: None) – Высота.

• weight (Optional[float], default: None) – Вес.

• comment_for_user (Optional[str], default: None) –

market_get_group_orders(offset=None, count=10)

Параметры:

• offset (Optional[int], default: None) – Смещение относительно первого найденного заказа для выборки определенного подмножества.

• count (int, default: 10) – Количество возвращаемых заказов.

market_get_order_by_id(order_id, user_id=None, extended=None)

Параметры:

• order_id (int) – Идентификатор заказа.

• user_id (Optional[int], default: None) – Идентификатор пользователя.

• extended (Optional[int], default: None) –

market_get_order_items(order_id, user_id=None, offset=None, count=50)

Параметры:

• order_id (int) – Идентификатор заказа.

• user_id (Optional[int], default: None) – Id пользователя, который сделал заказ.

• offset (Optional[int], default: None) – Смещение относительно первого найденного товара в заказе для выборки определенного подмножества.

• count (int, default: 50) – Количество возвращаемых товаров в заказе.

photos_get_chat_upload_server(chat_id, crop_x=None, crop_y=None, crop_width=None)

Параметры:

• chat_id (int) – Идентификатор беседы, для которой нужно загрузить фотографию.

• crop_x (Optional[float], default: None) – Координата x для обрезки фотографии (верхний правый угол).

• crop_y (Optional[float], default: None) – Координата y для обрезки фотографии (верхний правый угол).

• crop_width (Optional[int], default: None) – Ширина фотографии после обрезки в px.

photos_get_messages_upload_server()

photos_get_owner_cover_photo_upload_server(crop_x=None, crop_y=None, crop_x2=None, crop_y2=None)

Параметры:

• crop_x (Optional[float], default: None) – Координата X верхнего левого угла для обрезки изображения.

• crop_y (Optional[float], default: None) – Координата Y верхнего левого угла для обрезки изображения.

• crop_x2 (Optional[float], default: None) – Координата X нижнего правого угла для обрезки изображения.

• crop_y2 (Optional[float], default: None) – Координата Y нижнего правого угла для обрезки изображения.

photos_save_messages_photo(photo, server=None, hash=None)

Параметры:

• photo (str) – Параметр, возвращаемый в результате загрузки фотографии на сервер.

• server (Optional[int], default: None) – Параметр, возвращаемый в результате загрузки фотографии на сервер.

• hash (Optional[str], default: None) – Параметр, возвращаемый в результате загрузки фотографии на сервер.

photos_save_owner_cover_photo(hash, photo)

Параметры:

• hash (str) – Параметр hash, полученный в результате загрузки фотографии на сервер.

• photo (str) – Параметр photo, полученный в результате загрузки фотографии на сервер.

podcasts_search_podcast(search_string, offset=None, count=20)

Параметры:

• search_string (str) –

• offset (Optional[int], default: None) –

• count (int, default: 20) –

storage_get(key=None, keys=None, user_id=None)

Параметры:

• key (Optional[str], default: None) – Название переменной.

• keys (Optional[List[str]], default: None) – Список названий переменных. Если указано, параметр key не учитывается.

• user_id (Optional[int], default: None) – id пользователя, переменная которого устанавливается, в случае если данные запрашиваются серверным методом.

storage_get_keys(user_id, offset=None, count=100)

Параметры:

• user_id (int) – id пользователя, названия переменных которого получаются, в случае если данные запрашиваются серверным методом.

• offset (Optional[int], default: None) – Смещение, необходимое для выборки определенного подмножества названий переменных

• count (int, default: 100) – Количество названий переменных, информацию о которых необходимо получить.

Тип результата:

List

storage_set(key, value=None, user_id=None)

Параметры:

• key (str) – Название переменной. Может содержать символы латинского алфавита, цифры, знак тире, нижнее подчёркивание [a-zA-Z_-0-9].

• value (Optional[str], default: None) – Значение переменной, сохраняются только первые 4096 байта.

• user_id (Optional[int], default: None) – id пользователя, переменная которого устанавливается, в случае если данные запрашиваются серверным методом.

users_get(user_ids, fields=None, name_case='nom')

Параметры:

• user_ids (List[int]) – Идентификаторы пользователей

• fields (Optional[List[str]], default: None) – Список дополнительных полей профилей, которые необходимо вернуть.

• name_case (str, default: 'nom') –

  Падеж для склонения имени и фамилии пользователя. Возможные значения:

  Именительный – nom, Родительный – gen, Дательный – dat, Винительный – acc, Творительный – ins, Предложный – abl.

stories_delete(owner_id, story_id, stories=None)

Параметры:

• owner_id (int) – Идентификатор владельца истории.

• story_id (int) – Идентификатор истории.

• stories (Optional[List[str]], default: None) –

stories_get(owner_id, extended=None, fields=None)

Параметры:

• owner_id (int) – Идентификатор пользователя, истории которого необходимо получить.

• extended (Optional[int], default: None) – 1 — возвращать в ответе дополнительную информацию о профилях пользователей.

• fields (Optional[List[str]], default: None) –

stories_get_by_id(stories, extended=None, fields=None)

Параметры:

• stories (List[int]) – Идентификаторы историй.

• extended (Optional[int], default: None) – 1 — возвращать в ответе дополнительную информацию о пользователях.

• fields (Optional[List[str]], default: None) – Дополнительные поля профилей и сообществ, которые необходимо вернуть в ответе.

stories_get_photo_upload_server(add_to_news=None, user_ids=None, reply_to_story=None, link_text=None, link_url=None, clickable_stickers=None)

Параметры:

• add_to_news (Optional[int], default: None) – 1 — разместить историю в новостях. Обязательно, если не указан user_ids.

• user_ids (Optional[List[int]], default: None) – Идентификаторы пользователей, которые будут видеть историю (для отправки в личном сообщении). Обязательно, если add_to_news не передан.

• reply_to_story (Optional[str], default: None) – Идентификатор истории, в ответ на которую создается новая.

• link_text (Optional[str], default: None) – Текст ссылки для перехода из истории.

• link_url (Optional[str], default: None) – Адрес ссылки для перехода из истории. Допустимы только внутренние ссылки https://vk.com.

• clickable_stickers (default: None) – Объект кликабельного стикера.

stories_get_replies(owner_id, story_id, access_key=None, extended=None, fields=None)

Параметры:

• owner_id (int) – Идентификатор владельца истории.

• story_id (int) – Идентификатор истории.

• access_key (Optional[str], default: None) – Ключ доступа для приватного объекта.

• extended (Optional[int], default: None) – 1 — возвращать дополнительную информацию о профилях и сообществах.

• fields (Optional[List[str]], default: None) – Дополнительные поля профилей и сообществ, которые необходимо вернуть в ответе.

stories_get_stats(owner_id, story_id)

Параметры:

• owner_id (int) – Идентификатор владельца истории.

• story_id (int) – Идентификатор истории.

stories_get_video_upload_server(user_ids=None, add_to_news=None, reply_to_story=None, link_text=None, link_url=None, clickable_stickers=None)

Параметры:

• user_ids (Optional[List[int]], default: None) – Идентификаторы пользователей, которые будут видеть историю (для отправки в личном сообщении).

• add_to_news (Optional[int], default: None) – 1 — разместить историю в новостях.

• reply_to_story (Optional[str], default: None) – Идентификатор истории, в ответ на которую создается новая.

• link_text (Optional[str], default: None) – Текст ссылки для перехода из истории.

• link_url (Optional[str], default: None) – Адрес ссылки для перехода из истории.

• clickable_stickers (default: None) – Объект кликабельного стикера.

stories_get_viewers(owner_id, story_id, count=100, offset=None, extended=None)

Параметры:

• owner_id (int) – Идентификатор владельца истории.

• story_id (int) – Идентификатор истории.

• count (int, default: 100) – Максимальное число результатов в ответе.

• offset (Optional[int], default: None) – Сдвиг для получения определённого подмножества результатов.

• extended (Optional[int], default: None) – 1 — возвращать в ответе расширенную информацию о пользователях.

stories_hide_all_replies(owner_id)

Параметры:

owner_id (int) – Идентификатор пользователя, ответы от которого нужно скрыть.

stories_hide_reply(owner_id, story_id)

Параметры:

• owner_id (int) – Идентификатор владельца истории (ответной).

• story_id (int) – Идентификатор истории (ответной).

stories_save(upload_results, extended=None, fields=None)

Параметры:

• upload_results (List[str]) – Cписок строк, которые возвращает stories.getPhotoUploadServer или stories.getVideoUploadServer.

• extended (Optional[int], default: None) –

• fields (Optional[List[str]], default: None) –

utils_check_link(url)

Параметры:

url (str) – Внешняя ссылка, которую необходимо проверить.

utils_get_link_stats(key, source='vk_cc', access_key=None, interval='day', intervals_count=1, extended=None)

Параметры:

• key (str) – Сокращенная ссылка (часть URL после «vk.cc/»).

• source (str, default: 'vk_cc') –

• access_key (Optional[str], default: None) – Ключ доступа к приватной статистике ссылки.

• interval (str, default: 'day') – Единица времени для подсчета статистики. Возможные значения: hour, day, week, month, forever.

• intervals_count (int, default: 1) – Длительность периода для получения статистики в выбранных единицах (из параметра interval).

• extended (Optional[int], default: None) – 1 — возвращать расширенную статистику (пол/возраст/страна/город), 0 — возвращать только количество переходов.

utils_get_server_time()

Возвращает число, соответствующее времени в UnixTime.

utils_get_short_link(url, private=None)

Параметры:

• url (str) – URL, для которого необходимо получить сокращенный вариант.

• private (Optional[int], default: None) – 1 — статистика ссылки приватная, 0 — статистика ссылки общедоступная.

utils_resolve_screen_name(screen_name)

Параметры:

screen_name (str) – Короткое имя пользователя, группы или приложения.

wall_close_comments(owner_id, post_id)

Параметры:

• owner_id (int) –

• post_id (int) –

wall_create_comment(post_id, message=None, reply_to_comment=None, attachments=None, sticker_id=None)

Параметры:

• post_id (int) – Идентификатор записи на стене.

• message (Optional[str], default: None) – Текст комментария. Обязательный параметр, если не передан параметр attachments.

• reply_to_comment (Optional[int], default: None) – Идентификатор комментария, в ответ на который должен быть добавлен новый комментарий.

• attachments (default: None) –

• sticker_id (Optional[int], default: None) – Идентификатор стикера.