OpenVK API description¶
OpenVK API is based on VKontakte's API for compatibility. If you want to improve the API, then read this page.
To call the function, you need to go to /method/
URL, and then, the function name, for example: /method/Account.getProfileInfo
. The server will return JSON data. You can use GET or POST to send the Data.
π° above the function name means it requires authorization.
Authorization¶
To get token, you should call the "token" page:
/token?username={YOUR USERNAME}&password={YOUR PASSWORD}&grant_type=password
You'll get a response like this:
{
"access_token": "THERE IS A TOKEN. A LONG TOKEN ACTUALLY",
"expires_in": 0,
"user_id": 1
}
If you need to call the function that requires a token, just put the access_token
into your GET or POST request.
If you have two-factor authorization turned on, add a code
field to your POST request and fill it with, you guessed it, authorization code.
Account¶
getProfileInfo
π°¶
Returns the info about account.
{
"response":
{
"first_name": "Vladimir",
"id":1,
"last_name": "Barinov",
"home_town": "Moscow",
"status": "Status example",
"bdate": "1.1.1970",
"bdate_visibility": 0,
"phone": "+420 ** *** 228",
"relation": 2,
"sex": 2
}
}
Some fields are faked for VK API Compatibility
getInfo
π°¶
This is a dummy function
{
"response":{
"2fa_required":0,
"country":"CZ",
"eu_user":false,
"https_required":1,
"intro":0,
"community_comments":false,
"is_live_streaming_enabled":false,
"is_new_live_streaming_enabled":false,
"lang":1,
"no_wall_replies":0,
"own_posts_default":0
}
}
setOnline
π°¶
Set the online status to current. Always returns 1
.
setOffline
π°¶
Dummy function, always returns 1
.
getAppPermissions
¶
Dummy function, always returns 9355263
.
getCounters
π°¶
Returns the counters of Unread Messages
, Notifications
and Friends
Requests.
Friends¶
get
¶
Fields: user_id
, fields
, offset
, count
Returns the user's friend ID list with count.
add
π°¶
Fields: user_id
Sends a requests to another user or adds user to friends list.
Returns: 1
(friend request sent) or 2
(request from user approved)
remove
π°¶
Fields: user_id
Removes the user from friend list or the request.
Returns 1
if successed, otherwise will throw an error.
getLists
π°¶
Dummy function, always returns 0 items.
edit
, deleteList
, editList
π°¶
Dummy functions, always return 1
.
Groups¶
get
¶
Fields: user_id
, advanced
, fields
, offset
, count
Returns the user's groups (or IDs if advanced is 0) list with count.
fields
: verified
, has_photo
, photo_max_orig
, photo_max
getById
¶
Fields: groups_id
or group_id
, fields
Returns the info about group(s).
fields
: verified
, has_photo
, photo_max_orig
, photo_max
, members_count
, site
, description
, contacts
, can_post
Messages¶
getById
π°¶
Fields: message_ids
, preview_length
, extended
Returns the messages by it's IDs.
send
π°¶
Fields: user_id
, peer_id
, domain
, user_ids
, message
Sends a message to user. Will return the message's ID, if successed.
delete
π°¶
Fields: message_ids
Deletes the message.
restore
π°¶
Fields: message_ids
Restores deleted message.
getConversations
π°¶
Fields: offset
, count
20, filter
, extended
Returns user's chat list.
getHistory
π°¶
Fields: offset
, user_id
, peer_id
, start_message_id
, rev
, extended
Returns chat's history.
getLongPollHistory
π°¶
Fields: ts
, preview_length
, events_limit
, msgs_limit
Return's LongPoll history.
Check this if you don't know what is a LongPoll.
getLongPollServer
π°¶
Fields: need_pts
, lp_version
, group_id
Returns the address to LongPoll server.
Check this if you don't know what is a LongPoll.
Ovk (aka OpenVK specific methods)¶
version
¶
Returns the OpenVK version installed on an instance.
test
¶
Returns the information about access token.
chickenWings
¶
Returns ΠΊΡΡΠ»ΡΡΠΊΠΈ
string.
Utils¶
getServerTime
¶
Returns the time on the server.
Users¶
get
π°¶
Fields: user_ids
, fields
, offset
, count
.
Returns information about user or users.
fields
: verified
, sex
(not the orientation but the gender), has_photo
, photo_max_orig
, photo_max
, status
, screen_name
(aka short url), friend_status
, last_seen
, music
, movies
, tv
, books
, city
, interests
getFollowers
π°¶
Fields: user_id
, fields
, offset
, count
Returns the followers of user.
search
¶
Fields: q
, fields
, offset
, count
Searches the users by name, surname or bio, and returns the list.
Fields
are the same as with get
function.
Wall¶
get
¶
Fields: owner_id
, offset
, count
, extended
Returns the posts on the wall. Extended
parameter will also return profile info.
getById
¶
Fields: posts
, fields
, extended
Returns post(s) by pretty ID (like 1_3 or 32_3).
post
π°¶
Fields: owner_id
, message
, from_group
, signed
Creates new post on wall.
Also, there is a way to upload picture or video, just send the media named "photo" or "video" in your post request.
Newsfeed¶
get
π°¶
Fields: fields
, start_from
or offset
, count
, extended
Returns posts from newsfeed.
Likes¶
add
π°¶
Fields: type, owner_id, item_id
Likes the post. Returns count of likes.
remove
π°¶
Fields: type, owner_id, item_id
Removes like from the post. Returns count of likes.
isLiked
π°¶
Fields: user_id, type, owner_id, item_id
Checks if user liked the post or not
Error¶
If something goes wrong, the server will return you an error like this:
{
"error_code":28,
"error_msg":"Invalid username or password",
"request_params":
[
{
"key":"grant_type",
"value":"password"
},
{
"key":"password",
"value":"agreatpassword"
},
{
"key":"username",
"value":"cooluser@cock.li"
},
{
"key":"method",
"value":"internal.acquireToken"
},
{
"key":"oauth",
"value":1
}
]
}