{ "$schema": "../schema.json", "version": "5.199", "title": "VK API JSON Schema - objects", "description": "Contains JSON Schema documents explaining the VK.COM API - objects", "termsOfService": "https://dev.vk.com/rules", "definitions": { "callback_app_payload": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "app_id": { "type": "integer", "minimum": 0, "format": "int64", "required": true }, "payload": { "type": "string", "required": true } } }, "callback_audio_new": { "type": "object", "$ref": "../audio/objects.json#/definitions/audio_audio" }, "callback_base": { "type": "object", "properties": { "type": { "$ref": "../callback/objects.json#/definitions/callback_type", "required": true }, "group_id": { "type": "integer", "minimum": 0, "entity": "groups", "format": "int64", "required": true }, "event_id": { "type": "string", "description": "Unique event id. If it passed twice or more - you should ignore it.", "required": true }, "v": { "type": "string", "description": "API object version", "required": true }, "secret": { "type": "string" } } }, "callback_board_post_delete": { "type": "object", "properties": { "topic_owner_id": { "type": "integer", "entity": "owner", "minimum": 0, "required": true, "format": "int64" }, "topic_id": { "type": "integer", "minimum": 0, "required": true }, "id": { "type": "integer", "minimum": 0, "required": true }, "deleter_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64" } } }, "callback_board_post_edit": { "type": "object", "$ref": "../board/objects.json#/definitions/board_topic_comment" }, "callback_board_post_new": { "type": "object", "$ref": "../board/objects.json#/definitions/board_topic_comment" }, "callback_board_post_restore": { "type": "object", "$ref": "../board/objects.json#/definitions/board_topic_comment" }, "callback_confirmation": { "type": "object", "allOf": [ { "$ref": "../callback/objects.json#/definitions/callback_base" }, { "type": "object", "properties": { "type": { "type": "string", "$ref": "../callback/objects.json#/definitions/callback_type", "default": "confirmation" } } } ] }, "callback_donut_money_withdraw": { "type": "object", "properties": { "amount": { "type": "number", "minimum": 0, "required": true }, "amount_without_fee": { "type": "number", "minimum": 0, "required": true } } }, "callback_donut_money_withdraw_error": { "type": "object", "properties": { "reason": { "type": "string", "minimum": 0, "required": true } } }, "callback_donut_subscription_cancelled": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64" } } }, "callback_donut_subscription_create": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64" }, "amount": { "type": "integer", "minimum": 0, "required": true }, "amount_without_fee": { "type": "number", "minimum": 0, "required": true } } }, "callback_donut_subscription_expired": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64" } } }, "callback_donut_subscription_price_changed": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64" }, "amount_old": { "type": "integer", "minimum": 0, "required": true }, "amount_new": { "type": "integer", "minimum": 0, "required": true }, "amount_diff": { "type": "number", "minimum": 0 }, "amount_diff_without_fee": { "type": "number", "minimum": 0 } } }, "callback_donut_subscription_prolonged": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64" }, "amount": { "type": "integer", "minimum": 0, "required": true }, "amount_without_fee": { "type": "number", "minimum": 0, "required": true } } }, "callback_foreign_message": { "type": "object", "allOf": [ { "$ref": "../messages/objects.json#/definitions/messages_foreign_message" }, { "type": "object", "properties": { "is_cropped": { "type": "boolean" }, "fwd_messages": { "type": "array", "items": { "$ref": "../callback/objects.json#/definitions/callback_foreign_message" } }, "reply_message": { "$ref": "../callback/objects.json#/definitions/callback_foreign_message" } } } ] }, "callback_fwd_messages": { "type": "array", "description": "Forwarded messages", "items": { "$ref": "../callback/objects.json#/definitions/callback_foreign_message" } }, "callback_group_change_photo": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "photo": { "$ref": "../photos/objects.json#/definitions/photos_photo", "required": true } } }, "callback_group_change_settings": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "changes": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes" } } }, "callback_group_join": { "type": "object", "properties": { "user_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "join_type": { "$ref": "../callback/objects.json#/definitions/callback_group_join_type", "required": true } } }, "callback_group_join_type": { "type": "string", "enum": [ "join", "unsure", "accepted", "approved", "request" ] }, "callback_group_leave": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64" }, "self": { "$ref": "../base/objects.json#/definitions/base_bool_int" } } }, "callback_group_market": { "type": "integer", "enum": [ 0, 1 ], "enumNames": [ "disabled", "open" ] }, "callback_group_officer_role": { "type": "integer", "enum": [ 0, 1, 2, 3 ], "enumNames": [ "none", "moderator", "editor", "administrator" ] }, "callback_group_officers_edit": { "type": "object", "properties": { "admin_id": { "type": "integer", "entity": "owner", "minimum": 0, "required": true, "format": "int64" }, "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "level_old": { "$ref": "../callback/objects.json#/definitions/callback_group_officer_role", "required": true }, "level_new": { "$ref": "../callback/objects.json#/definitions/callback_group_officer_role", "required": true } } }, "callback_group_settings_changes": { "type": "object", "properties": { "title": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_string_values" }, "screen_name": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_string_values" }, "event_start_date": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "event_finish_date": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "event_group_id": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "donations": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "wall": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "replies": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "topics": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "photos": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "docs": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "messages": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "market": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "market_wiki": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "board": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "links": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "audio": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "video": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "can_post_topics": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "can_post_albums": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "can_post_video": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "disable_market_comments": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "status_default": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "access": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "email": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_string_values" }, "country_id": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "city_id": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "address": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_string_values" }, "description": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_string_values" }, "website": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_string_values" }, "phone": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_string_values" }, "age_limits": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "category_v2": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "public_category": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" }, "public_subcategory": { "$ref": "../callback/objects.json#/definitions/callback_group_settings_changes_integer_values" } } }, "callback_group_settings_changes_integer_values": { "type": "object", "properties": { "old_value": { "type": "integer" }, "new_value": { "type": "integer" } } }, "callback_group_settings_changes_string_values": { "type": "object", "properties": { "old_value": { "type": "string" }, "new_value": { "type": "string" } } }, "callback_info_for_bots": { "type": "object", "properties": { "button_actions": { "type": "array", "items": { "$ref": "../messages/objects.json#/definitions/messages_template_action_type_names" } }, "keyboard": { "type": "boolean", "description": "client has support keyboard" }, "inline_keyboard": { "type": "boolean", "description": "client has support inline keyboard" }, "carousel": { "type": "boolean", "description": "client has support carousel" }, "lang_id": { "type": "integer", "description": "client or user language id" } } }, "callback_like_add_remove": { "type": "object", "properties": { "liker_id": { "entity": "owner", "type": "integer", "required": true, "format": "int64" }, "object_type": { "type": "string", "enum": [ "video", "photo", "post", "comment", "note", "topic_comment", "photo_comment", "video_comment", "market", "market_comment" ], "required": true }, "object_owner_id": { "type": "integer", "entity": "owner", "required": true, "format": "int64" }, "object_id": { "type": "integer", "required": true }, "post_id": { "type": "integer", "minimum": 0, "required": true }, "thread_reply_id": { "type": "integer", "minimum": 0 } } }, "callback_market_comment": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "required": true }, "from_id": { "entity": "owner", "type": "integer", "required": true, "format": "int64" }, "date": { "type": "integer", "minimum": 0, "required": true }, "text": { "type": "string" }, "market_owner_id": { "entity": "owner", "type": "integer", "format": "int64" }, "photo_id": { "type": "integer" } } }, "callback_market_comment_delete": { "type": "object", "properties": { "owner_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "id": { "type": "integer", "required": true }, "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "item_id": { "type": "integer", "minimum": 0, "required": true } } }, "callback_message": { "type": "object", "allOf": [ { "$ref": "../messages/objects.json#/definitions/messages_message" }, { "type": "object", "properties": { "influence_score": { "type": "number" }, "reply_message": { "$ref": "../callback/objects.json#/definitions/callback_foreign_message" }, "fwd_messages": { "$ref": "../callback/objects.json#/definitions/callback_fwd_messages" } } } ] }, "callback_message_allow": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "key": { "type": "string", "required": true } } }, "callback_message_deny": { "type": "object", "properties": { "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true } } }, "callback_message_event": { "type": "object", "properties": { "user_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "peer_id": { "type": "integer", "format": "int64", "required": true }, "event_id": { "type": "string", "required": true }, "payload": { "type": "string", "required": true }, "conversation_message_id": { "type": "integer", "format": "int64", "minimum": 1 } } }, "callback_message_new": { "type": "object", "$ref": "../callback/objects.json#/definitions/callback_message_object" }, "callback_message_object": { "type": "object", "properties": { "client_info": { "$ref": "../callback/objects.json#/definitions/callback_info_for_bots" }, "message": { "$ref": "../callback/objects.json#/definitions/callback_message" } } }, "callback_message_reaction_event": { "type": "object", "properties": { "reacted_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "peer_id": { "type": "integer", "format": "int64", "required": true }, "cmid": { "type": "integer", "minimum": 1, "required": true }, "reaction_id": { "type": "integer", "minimum": 1, "maximum": 64 } } }, "callback_message_read": { "type": "object", "properties": { "from_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "peer_id": { "type": "integer", "format": "int64", "required": true }, "read_message_id": { "type": "integer", "required": true }, "conversation_message_id": { "type": "integer", "minimum": 1, "required": true } } }, "callback_message_typing_state": { "type": "object", "properties": { "from_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "to_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "state": { "type": "string", "enum": [ "message_typing_state", "0", "1", "2", "3", "4", "5" ], "required": true } } }, "callback_photo_comment": { "type": "object", "allOf": [ { "$ref": "../wall/objects.json#/definitions/wall_wall_comment" }, { "properties": { "photo_owner_id": { "type": "integer", "entity": "owner", "minimum": 0, "required": true, "format": "int64" } } } ] }, "callback_photo_comment_delete": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "required": true }, "owner_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "photo_id": { "type": "integer", "minimum": 0, "required": true }, "deleter_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true } } }, "callback_photo_new": { "type": "object", "$ref": "../photos/objects.json#/definitions/photos_photo" }, "callback_poll_vote_new": { "type": "object", "properties": { "owner_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "poll_id": { "type": "integer", "minimum": 0, "required": true }, "option_id": { "type": "integer", "minimum": 0, "required": true }, "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true } } }, "callback_type": { "type": "string", "enum": [ "audio_new", "board_post_new", "board_post_edit", "board_post_restore", "board_post_delete", "confirmation", "group_leave", "group_join", "group_change_photo", "group_change_settings", "group_officers_edit", "lead_forms_new", "market_comment_new", "market_comment_delete", "market_comment_edit", "market_comment_restore", "market_order_new", "market_order_edit", "message_new", "message_reply", "message_edit", "message_allow", "message_deny", "message_read", "message_typing_state", "messages_edit", "message_reaction_event", "photo_new", "photo_comment_new", "photo_comment_delete", "photo_comment_edit", "photo_comment_restore", "poll_vote_new", "user_block", "user_unblock", "video_new", "video_comment_new", "video_comment_delete", "video_comment_edit", "video_comment_restore", "wall_post_new", "wall_reply_new", "wall_reply_edit", "wall_reply_delete", "wall_reply_restore", "wall_repost", "wall_schedule_post_new", "wall_schedule_post_delete" ] }, "callback_user_block": { "type": "object", "properties": { "admin_id": { "type": "integer", "entity": "owner", "minimum": 0, "required": true, "format": "int64" }, "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "unblock_date": { "type": "integer", "minimum": 0, "required": true }, "reason": { "type": "integer", "minimum": 0, "required": true }, "comment": { "type": "string" } } }, "callback_user_unblock": { "type": "object", "properties": { "admin_id": { "type": "integer", "entity": "owner", "minimum": 0, "required": true, "format": "int64" }, "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "by_end_date": { "type": "integer", "minimum": 0, "required": true } } }, "callback_video_comment": { "type": "object", "allOf": [ { "$ref": "../wall/objects.json#/definitions/wall_wall_comment" }, { "properties": { "video_owner_id": { "type": "integer", "entity": "owner", "format": "int64" } } } ] }, "callback_video_comment_delete": { "type": "object", "properties": { "id": { "type": "integer", "minimum": 0, "required": true }, "owner_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "deleter_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "video_id": { "type": "integer", "minimum": 0, "required": true } } }, "callback_video_new": { "type": "object", "$ref": "../audio/objects.json#/definitions/audio_audio" }, "callback_vkpay_transaction": { "type": "object", "properties": { "amount": { "type": "integer", "minimum": 0, "required": true }, "from_id": { "type": "integer", "entity": "owner", "required": true, "format": "int64" }, "description": { "type": "string", "required": true }, "date": { "type": "integer", "minimum": 0, "required": true }, "payload": { "type": "string" } } }, "callback_wall_comment_delete": { "type": "object", "properties": { "owner_id": { "type": "integer", "entity": "owner", "format": "int64", "required": true }, "id": { "type": "integer", "minimum": 0, "required": true }, "user_id": { "type": "integer", "minimum": 0, "entity": "owner", "format": "int64", "required": true }, "post_id": { "type": "integer", "minimum": 0, "required": true } } }, "callback_wall_post_new": { "type": "object", "$ref": "../wall/objects.json#/definitions/wall_wallpost" }, "callback_wall_reply_edit": { "type": "object", "$ref": "../wall/objects.json#/definitions/wall_wall_comment" }, "callback_wall_reply_new": { "type": "object", "$ref": "../wall/objects.json#/definitions/wall_wall_comment" }, "callback_wall_reply_restore": { "type": "object", "$ref": "../wall/objects.json#/definitions/wall_wall_comment" }, "callback_wall_repost": { "type": "object", "$ref": "../wall/objects.json#/definitions/wall_wallpost" } } }