Методы¶
Подробное описание всех методов API
/get¶
Получить список аудио пользователя
Параметр |
Тип |
Описание |
---|---|---|
|
int, str |
ID пользователя. Можно передавать URI страницы и ID страницы |
|
int |
Количество музыки, которое необходимо получить. Параметр не обязателен. По умолчанию 10,000 треков |
|
int |
Cмещение, необходимое для выборки определенного подмножества музыки. Параметр не обязателен. По умолчанию 0 |
Пример запроса и ответа:
/get?owner_id=kamasutra2281337&pswd=...
[
{
"artist": "P!nk",
"duration": 215,
"id": 456241099,
"index": "1",
"owner_id": 360089815,
"title": "So What",
"url": "https://cs1-77v4.vkuseraudio.net/p3/c59204daca143a.mp3"
},
{
"artist": "P!nk",
"duration": 226,
"id": 456241098,
"index": "2",
"owner_id": 360089815,
"title": "Whataya Want from Me",
"url": "https://cs1-63v4.vkuseraudio.net/p4/dbccdfe10978fc.mp3"
},
{
"artist": "Animal Джаz",
"duration": 252,
"id": 456241096,
"index": "3",
"owner_id": 360089815,
"title": "Шаг вдох (Remastered)",
"url": "https://cs1-60v4.vkuseraudio.net/p14/87b9c4b7f0258c.mp3"
},
...
]
/search¶
Найти музыку в поиске. Кол-во 200 штук
Параметр |
Тип |
Описание |
---|---|---|
|
str |
Текст запроса |
|
int |
Вид сортировки. 2 — по популярности, 1 — по длительности аудиозаписи, 0 — по дате добавления. Этот параметр не обязателен. По умолчанию 0 |
|
bool |
Если этот параметр равен 1, возможные ошибки в поисковом запросе будут исправлены. Например, при поисковом запросе
Этот параметр не обязателен. По умолчанию 0 |
|
bool |
Если этот параметр равен 1, поиск будет осуществляться только по названию исполнителя. Этот параметр не обязателен. По умолчанию 0 |
|
int, str |
ID пользователя. Если передан этот параметр, то музыка будет искаться у заданого пользователя. Можно передавать URI страницы и ID страницы. Этот параметр не обязателен. По умолчанию этот параметр не участвует в запросе на VK API |
Пример запроса и ответа
/search?q=Toxicity&pswd=...
[
{
"artist": "System Of A Down",
"duration": 219,
"id": 456239438,
"index": "1",
"owner_id": 371745467,
"title": "Toxicity",
"url": "https://cs1-71v4.vkuseraudio.net/p23/fb342ce1e62fd5.mp3"
},
{
"artist": "Best Guitar Songs, Rockstars, Rock Classics, Gym Rock, Classic Rock, The Rock Heroes, The Rock Masters, Fourth Heads, Indie Rockers, Classic Rock Heroes, Indie Rock",
"duration": 221,
"id": 456314420,
"index": "2",
"owner_id": 371745456,
"title": "Toxicity",
"url": "https://cs1-42v4.vkuseraudio.net/p13/47afc1050a4fba.mp3"
},
{
"artist": "Melodicka Bros",
"duration": 214,
"id": 66716516,
"index": "3",
"owner_id": -2001716516,
"title": "Toxicity (Cyberpunk)",
"url": "https://cs1-78v4.vkuseraudio.net/p23/01436c15a59d33.mp3"
},
...
]
/getAlbums¶
Получить первые 200 штук альбомов
Параметр |
Тип |
Описание |
---|---|---|
|
int, str |
ID пользователя. Можно передавать URI страницы и ID страницы |
Пример запроса и ответа:
/getAlbums?owner_id=kamasutra2281337&pswd=...
[
{
"count": 11,
"description": "Описание",
"id": 54,
"index": "1",
"owner_id": 360089815,
"title": "Duet (Original Game Soundtrack)"
},
{
"count": 40,
"description": "Описание",
"id": 53,
"index": "2",
"owner_id": 360089815,
"title": "Название плейлиста"
},
...
]
/getAlbum¶
Получить все аудиозаписи из альбома
Параметр |
Тип |
Описание |
---|---|---|
|
int |
ID пользователя |
|
int |
ID альбома |
|
int |
Количество музыки, которое необходимо получить. Параметр не обязателен. По умолчанию 10,000 треков |
|
int |
Cмещение, необходимое для выборки определенного подмножества музыки. Параметр не обязателен. По умолчанию 0 |
Пример запроса и ответа:
/getAlbum?owner_id=360089815&album_id=54&pswd=...
[
{
"artist": "Tim Shiel",
"duration": 284,
"id": 57362372,
"index": "1",
"owner_id": -2001362372,
"title": "Theme for Duet",
"url": "https://cs1-77v4.vkuseraudio.net/p16/a48800706fe2fd.mp3"
},
{
"artist": "Tim Shiel",
"duration": 238,
"id": 57362371,
"index": "2",
"owner_id": -2001362371,
"title": "Nay",
"url": "https://cs1-80v4.vkuseraudio.net/p2/ecee1713a5cb2a.mp3"
},
{
"artist": "Tim Shiel",
"duration": 170,
"id": 57362369,
"index": "3",
"owner_id": -2001362369,
"title": "Tempa",
"url": "https://psv4.vkuseraudio.net/c813220/u474499264/audios/d4f786ab7265.mp3"
},
...
]
/mp3¶
Обязательный метод. Без него музыка бы не играла. Это из-за ограничений ВК. В параметры передаете ссылку на музыку из ВК. Обязательно проверяйте “есть ли .mp3 в ссылке”. Это просто реализовать при помощи регулярных выражений
Параметр |
Тип |
Описание |
---|---|---|
|
str |
URI VK музыки. Важно: в Е2 используйте потому что ссылка может иметь запрещенные символы для URI параметров. |
Пример вызова:
/mp3?url=https://cs1-43v4.vkuseraudio.net/p8/c0097081bd4a30.mp3&pswd=topsecret
Пример вызова в Е2:
Password = "topsecret"
URL = "https://site.ru/mp3?url=" + httpUrlEncode("https://cs1-43v4.vkuseraudio.net/p8/c0097081bd4a30.mp3") + "&pswd=" + Password
soundURLload(1, URL, 100, 0, owner())
/m3u8¶
Бывают случаи, когда в ссылке нету .mp3
, а только какой-то непонятный index.m3u8
. Так вот, это тоже ссылка на музыку. Вк использует HLS (HTTP Live Streaming)… Сервис имеет возможность декодировать эти ссылки и транслировать.
Но есть небольшой ньюанс. Во-первых, сервис декодирует их дольше, чем .mp3
, примерно 10 секунд, это первые 256 Кбайт музыки. Во-вторых, E2 не любит стримы музыки. Имеется в виду, что нельзя будет крутить время (soundURLtime(...)
). Но не бойтесь, они встречаются редко
Вызывается так же как и метод /mp3 но с ссылкой c index.m3u8
Параметр |
Тип |
Описание |
---|---|---|
|
str |
URI VK музыки. Важно: в Е2 используйте потому что ссылка может иметь запрещенные символы для URI параметров. |
/userId¶
Получить user_id
из ссылки или названия пользователя
Параметр |
Тип |
Описание |
---|---|---|
|
str |
Ссылка или имя пользователя. Например:
|
Пример запроса и ответа:
/userId?user=kamasutra2281337&pswd=...
{
"id": 360089815
}
/getCount¶
Получить кол-во аудиозаписей у пользователя
Параметр |
Тип |
Описание |
---|---|---|
|
int, str |
ID пользователя |
Пример запроса и ответа:
/getCount?owner_id=kamasutra2281337&pswd=...
{
"count": 1231
}
Подсказка
Так же можно указывать ID групп и их название. Они отличаются от пользовательских ID только минусом в начале.
Например: -30666517
, https://vk.com/club30666517
, https://vk.com/tproger
, tproger
, club30666517