Musicfun WebSocket API 1.0 documentation

Musicfun WebSocket API 1.0

application/json

Reactively handle server events on the client

Servers

wss://musicfun.it-incubator.app/api/1.0/wssocket.io 4europe
Allows clients to connect to our Socket.IO server via the WebSocket protocol.

port
required
string
Secure connection (TLS) is available on port 443.

Default value:"443"
Security:
HTTP
Scheme: bearer

Operations

PUB tracks.track-published
Emitted when a user publishes their track.
Accepts the following message:
tracks.track-published
object
uid: TrackPublishedEvent
type
required
string
Allowed values:
"tracks.track-published"
required
object
uid: TrackPublishedEventPayload
required
object
uid: TrackDetailsResource
id
required
string
Unique identifier of the track

type
required
string
Resource type (should be "tracks")

required
object
uid: TrackDetailsAttributes
title
required
string
<= 100 characters
Track title

lyrics
string
<= 5000 characters
Track lyrics text

releaseDate
string
format: date-time
Release date in ISO 8601 format

addedAt
required
string
format: date-time
Date and time when the track was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the track was last updated (ISO 8601)

duration
required
number
Duration of the track in seconds

likesCount
required
number
Total number of likes for this track

dislikesCount
required
deprecated
number
Total number of dislikes for this track

required
array<object>
List of attachments related to the track

id
required
string
Unique identifier of the entity

addedAt
required
string
format: date-time
Date and time when the entity was added

updatedAt
required
string
format: date-time
Date and time when the entity was last updated

version
required
number
Version number of the entity (for concurrency control)

url
required
string
Public URL to access the uploaded file

contentType
required
string
MIME type of the file

originalName
required
string
Original filename uploaded by the user

fileSize
required
number
Size of the file in bytes

required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags associated with the track

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

required
array<object>
Artists associated with the track

id
required
string
Unique identifier of the artist

name
required
string
Name of the artist

required
object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
isPublished
required
boolean
Publication status of the track

publishedAt
string
format: date-time
Publication date in ISO 8601 format

currentUserReaction
required
number
User reaction: 0 – guest or no reaction; 1 – user liked; -1 – user disliked

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "tracks.track-published", "payload": { "data": { "id": "string", "type": "tracks", "attributes": { "title": "string", "lyrics": "string", "releaseDate": "2019-08-24T14:15:22Z", "addedAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "duration": 0, "likesCount": 0, "dislikesCount": 0, "attachments": [ { "id": "string", "addedAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "version": 0, "url": "https://cdn.example.com/uploads/track123/cover.jpg", "contentType": "image/jpeg", "originalName": "cover.jpg", "fileSize": 34872 } ], "images": { "main": [ { "type": "original", "width": 0, "height": 0, "fileSize": 0, "url": "string" } ] }, "tags": [ { "id": "string", "name": "string" } ], "artists": [ { "id": "string", "name": "string" } ], "user": { "id": "string", "name": "string" }, "isPublished": true, "publishedAt": "2019-08-24T14:15:22Z", "currentUserReaction": 0 } } } }

This example has been generated automatically.
PUB tracks.track-added-to-playlist
Emitted when someone adds your track to their playlist.
Accepts the following message:
tracks.track-added-to-playlist
object
uid: TrackAddedToPlaylistEvent
type
required
string
Allowed values:
"tracks.track-added-to-playlist"
required
object
uid: TrackAddedToPlaylistEventPayload
trackId
required
string
trackTitle
required
string
playlistId
required
string
playlistTitle
required
string
userId
required
string
userName
required
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "tracks.track-added-to-playlist", "payload": { "trackId": "string", "trackTitle": "string", "playlistId": "string", "playlistTitle": "string", "userId": "string", "userName": "string" } }

This example has been generated automatically.
PUB tracks.track-liked
Emitted when someone likes your track.
Accepts the following message:
tracks.track-liked
object
uid: TrackLikedEvent
type
required
string
Allowed values:
"tracks.track-liked"
required
object
uid: TrackLikedEventPayload
trackId
required
string
trackTitle
required
string
userId
required
string
userName
required
string
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "tracks.track-liked", "payload": { "trackId": "string", "trackTitle": "string", "userId": "string", "userName": "string" } }

This example has been generated automatically.
PUB tracks.track-image-processed
Emitted when thumbnails for a track image are generated.
Accepts the following message:
tracks.track-image-processed
object
uid: TrackImageProcessedEvent
type
required
string
Allowed values:
"tracks.track-image-processed"
required
object
uid: ImageProcessedEventPayloadBase
itemId
required
string
required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "tracks.track-image-processed", "payload": { "itemId": "string", "images": { "main": [ { "type": "original", "width": 0, "height": 0, "fileSize": 0, "url": "string" } ] } } }

This example has been generated automatically.
PUB tracks.playlist-image-processed
Emitted when thumbnails for a playlist image are generated.
Accepts the following message:
tracks.playlist-image-processed
object
uid: PlaylistImageProcessedEvent
type
required
string
Allowed values:
"tracks.playlist-image-processed"
required
object
uid: ImageProcessedEventPayloadBase
itemId
required
string
required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "tracks.playlist-image-processed", "payload": { "itemId": "string", "images": { "main": [ { "type": "original", "width": 0, "height": 0, "fileSize": 0, "url": "string" } ] } } }

This example has been generated automatically.
PUB tracks.playlist-created
Emitted when a playlist is created.
Accepts the following message:
tracks.playlist-created
object
uid: PlaylistCreatedEvent
type
required
string
Allowed values:
"tracks.playlist-created"
required
object
uid: PlaylistCreatedEventPayload
required
object
uid: PlaylistResource
id
required
string
Unique identifier of the playlist

type
required
string
Resource type (should be "playlists")

required
object
uid: PlaylistAttributes
title
required
string
Title of the playlist

description
required
string
Description of the playlist

addedAt
required
string
format: date-time
Date and time when the playlist was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the playlist was last updated (ISO 8601)

order
required
number
Order index of the playlist

required
allOf
User who created the playlist

object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
required
allOf
Images associated with the playlist

object
uid: PlaylistImagesOutputDTO
array<object>
Original images and thumbnail previews

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags linked to the playlist

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

likesCount
required
number
Total number of likes for this playlist

dislikesCount
required
number
Total number of dislikes for this playlist

required
allOf
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Consists of:
number
uid: ReactionValue
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "tracks.playlist-created", "payload": { "data": { "id": "string", "type": "playlists", "attributes": { "title": "string", "description": "string", "addedAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "order": 0, "user": { "id": "string", "name": "string" }, "images": { "main": [ { "type": "original", "width": 0, "height": 0, "fileSize": 0, "url": "string" } ] }, "tags": [ { "id": "string", "name": "string" } ], "likesCount": 0, "dislikesCount": 0, "currentUserReaction": 0 } } } }

This example has been generated automatically.
PUB tracks.playlist-updated
Emitted when playlist information is updated (description, title, image, etc.).
Accepts the following message:
tracks.playlist-updated
object
uid: PlaylistUpdatedEvent
type
required
string
Allowed values:
"tracks.playlist-updated"
required
object
uid: PlaylistUpdatedEventPayload
required
object
uid: PlaylistResource
id
required
string
Unique identifier of the playlist

type
required
string
Resource type (should be "playlists")

required
object
uid: PlaylistAttributes
title
required
string
Title of the playlist

description
required
string
Description of the playlist

addedAt
required
string
format: date-time
Date and time when the playlist was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the playlist was last updated (ISO 8601)

order
required
number
Order index of the playlist

required
allOf
User who created the playlist

object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
required
allOf
Images associated with the playlist

object
uid: PlaylistImagesOutputDTO
array<object>
Original images and thumbnail previews

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags linked to the playlist

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

likesCount
required
number
Total number of likes for this playlist

dislikesCount
required
number
Total number of dislikes for this playlist

required
allOf
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Consists of:
number
uid: ReactionValue
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Examples
{ "type": "tracks.playlist-updated", "payload": { "data": { "id": "string", "type": "playlists", "attributes": { "title": "string", "description": "string", "addedAt": "2019-08-24T14:15:22Z", "updatedAt": "2019-08-24T14:15:22Z", "order": 0, "user": { "id": "string", "name": "string" }, "images": { "main": [ { "type": "original", "width": 0, "height": 0, "fileSize": 0, "url": "string" } ] }, "tags": [ { "id": "string", "name": "string" } ], "likesCount": 0, "dislikesCount": 0, "currentUserReaction": 0 } } } }

This example has been generated automatically.

Schemas

object
uid: TrackAttachment
id
required
string
Unique identifier of the entity

addedAt
required
string
format: date-time
Date and time when the entity was added

updatedAt
required
string
format: date-time
Date and time when the entity was last updated

version
required
number
Version number of the entity (for concurrency control)

url
required
string
Public URL to access the uploaded file

contentType
required
string
MIME type of the file

originalName
required
string
Original filename uploaded by the user

fileSize
required
number
Size of the file in bytes

Additional properties are allowed.
ImageSizeType
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
object
uid: ImageVariant
required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
object
uid: TagRef
id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

Additional properties are allowed.
object
uid: ArtistRef
id
required
string
Unique identifier of the artist

name
required
string
Name of the artist

Additional properties are allowed.
object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
object
uid: TrackDetailsAttributes
title
required
string
<= 100 characters
Track title

lyrics
string
<= 5000 characters
Track lyrics text

releaseDate
string
format: date-time
Release date in ISO 8601 format

addedAt
required
string
format: date-time
Date and time when the track was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the track was last updated (ISO 8601)

duration
required
number
Duration of the track in seconds

likesCount
required
number
Total number of likes for this track

dislikesCount
required
deprecated
number
Total number of dislikes for this track

required
array<object>
List of attachments related to the track

id
required
string
Unique identifier of the entity

addedAt
required
string
format: date-time
Date and time when the entity was added

updatedAt
required
string
format: date-time
Date and time when the entity was last updated

version
required
number
Version number of the entity (for concurrency control)

url
required
string
Public URL to access the uploaded file

contentType
required
string
MIME type of the file

originalName
required
string
Original filename uploaded by the user

fileSize
required
number
Size of the file in bytes

required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags associated with the track

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

required
array<object>
Artists associated with the track

id
required
string
Unique identifier of the artist

name
required
string
Name of the artist

required
object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
isPublished
required
boolean
Publication status of the track

publishedAt
string
format: date-time
Publication date in ISO 8601 format

currentUserReaction
required
number
User reaction: 0 – guest or no reaction; 1 – user liked; -1 – user disliked

Allowed values:
0
1
-1
Additional properties are allowed.
object
uid: TrackDetailsResource
id
required
string
Unique identifier of the track

type
required
string
Resource type (should be "tracks")

required
object
uid: TrackDetailsAttributes
title
required
string
<= 100 characters
Track title

lyrics
string
<= 5000 characters
Track lyrics text

releaseDate
string
format: date-time
Release date in ISO 8601 format

addedAt
required
string
format: date-time
Date and time when the track was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the track was last updated (ISO 8601)

duration
required
number
Duration of the track in seconds

likesCount
required
number
Total number of likes for this track

dislikesCount
required
deprecated
number
Total number of dislikes for this track

required
array<object>
List of attachments related to the track

id
required
string
Unique identifier of the entity

addedAt
required
string
format: date-time
Date and time when the entity was added

updatedAt
required
string
format: date-time
Date and time when the entity was last updated

version
required
number
Version number of the entity (for concurrency control)

url
required
string
Public URL to access the uploaded file

contentType
required
string
MIME type of the file

originalName
required
string
Original filename uploaded by the user

fileSize
required
number
Size of the file in bytes

required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags associated with the track

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

required
array<object>
Artists associated with the track

id
required
string
Unique identifier of the artist

name
required
string
Name of the artist

required
object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
isPublished
required
boolean
Publication status of the track

publishedAt
string
format: date-time
Publication date in ISO 8601 format

currentUserReaction
required
number
User reaction: 0 – guest or no reaction; 1 – user liked; -1 – user disliked

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
object
uid: TrackPublishedEventPayload
required
object
uid: TrackDetailsResource
id
required
string
Unique identifier of the track

type
required
string
Resource type (should be "tracks")

required
object
uid: TrackDetailsAttributes
title
required
string
<= 100 characters
Track title

lyrics
string
<= 5000 characters
Track lyrics text

releaseDate
string
format: date-time
Release date in ISO 8601 format

addedAt
required
string
format: date-time
Date and time when the track was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the track was last updated (ISO 8601)

duration
required
number
Duration of the track in seconds

likesCount
required
number
Total number of likes for this track

dislikesCount
required
deprecated
number
Total number of dislikes for this track

required
array<object>
List of attachments related to the track

id
required
string
Unique identifier of the entity

addedAt
required
string
format: date-time
Date and time when the entity was added

updatedAt
required
string
format: date-time
Date and time when the entity was last updated

version
required
number
Version number of the entity (for concurrency control)

url
required
string
Public URL to access the uploaded file

contentType
required
string
MIME type of the file

originalName
required
string
Original filename uploaded by the user

fileSize
required
number
Size of the file in bytes

required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags associated with the track

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

required
array<object>
Artists associated with the track

id
required
string
Unique identifier of the artist

name
required
string
Name of the artist

required
object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
isPublished
required
boolean
Publication status of the track

publishedAt
string
format: date-time
Publication date in ISO 8601 format

currentUserReaction
required
number
User reaction: 0 – guest or no reaction; 1 – user liked; -1 – user disliked

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: TrackPublishedEvent
type
required
string
Allowed values:
"tracks.track-published"
required
object
uid: TrackPublishedEventPayload
required
object
uid: TrackDetailsResource
id
required
string
Unique identifier of the track

type
required
string
Resource type (should be "tracks")

required
object
uid: TrackDetailsAttributes
title
required
string
<= 100 characters
Track title

lyrics
string
<= 5000 characters
Track lyrics text

releaseDate
string
format: date-time
Release date in ISO 8601 format

addedAt
required
string
format: date-time
Date and time when the track was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the track was last updated (ISO 8601)

duration
required
number
Duration of the track in seconds

likesCount
required
number
Total number of likes for this track

dislikesCount
required
deprecated
number
Total number of dislikes for this track

required
array<object>
List of attachments related to the track

id
required
string
Unique identifier of the entity

addedAt
required
string
format: date-time
Date and time when the entity was added

updatedAt
required
string
format: date-time
Date and time when the entity was last updated

version
required
number
Version number of the entity (for concurrency control)

url
required
string
Public URL to access the uploaded file

contentType
required
string
MIME type of the file

originalName
required
string
Original filename uploaded by the user

fileSize
required
number
Size of the file in bytes

required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags associated with the track

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

required
array<object>
Artists associated with the track

id
required
string
Unique identifier of the artist

name
required
string
Name of the artist

required
object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
isPublished
required
boolean
Publication status of the track

publishedAt
string
format: date-time
Publication date in ISO 8601 format

currentUserReaction
required
number
User reaction: 0 – guest or no reaction; 1 – user liked; -1 – user disliked

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: TrackAddedToPlaylistEventPayload
trackId
required
string
trackTitle
required
string
playlistId
required
string
playlistTitle
required
string
userId
required
string
userName
required
string
Additional properties are allowed.
object
uid: TrackAddedToPlaylistEvent
type
required
string
Allowed values:
"tracks.track-added-to-playlist"
required
object
uid: TrackAddedToPlaylistEventPayload
trackId
required
string
trackTitle
required
string
playlistId
required
string
playlistTitle
required
string
userId
required
string
userName
required
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: TrackLikedEventPayload
trackId
required
string
trackTitle
required
string
userId
required
string
userName
required
string
Additional properties are allowed.
object
uid: TrackLikedEvent
type
required
string
Allowed values:
"tracks.track-liked"
required
object
uid: TrackLikedEventPayload
trackId
required
string
trackTitle
required
string
userId
required
string
userName
required
string
Additional properties are allowed.
Additional properties are allowed.
object
uid: ImageProcessedEventPayloadBase
itemId
required
string
required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
Additional properties are allowed.
object
uid: TrackImageProcessedEvent
type
required
string
Allowed values:
"tracks.track-image-processed"
required
object
uid: ImageProcessedEventPayloadBase
itemId
required
string
required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: PlaylistImageProcessedEvent
type
required
string
Allowed values:
"tracks.playlist-image-processed"
required
object
uid: ImageProcessedEventPayloadBase
itemId
required
string
required
object
uid: TrackImages
array<object>
List of original images and thumbnail versions (e.g., original, 320x180, etc.)

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: PlaylistImagesOutputDTO
array<object>
Original images and thumbnail previews

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
ReactionValue
number
uid: ReactionValue
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Allowed values:
0
1
-1
object
uid: PlaylistAttributes
title
required
string
Title of the playlist

description
required
string
Description of the playlist

addedAt
required
string
format: date-time
Date and time when the playlist was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the playlist was last updated (ISO 8601)

order
required
number
Order index of the playlist

required
allOf
User who created the playlist

object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
required
allOf
Images associated with the playlist

object
uid: PlaylistImagesOutputDTO
array<object>
Original images and thumbnail previews

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags linked to the playlist

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

likesCount
required
number
Total number of likes for this playlist

dislikesCount
required
number
Total number of dislikes for this playlist

required
allOf
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Consists of:
number
uid: ReactionValue
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Allowed values:
0
1
-1
Additional properties are allowed.
object
uid: PlaylistResource
id
required
string
Unique identifier of the playlist

type
required
string
Resource type (should be "playlists")

required
object
uid: PlaylistAttributes
title
required
string
Title of the playlist

description
required
string
Description of the playlist

addedAt
required
string
format: date-time
Date and time when the playlist was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the playlist was last updated (ISO 8601)

order
required
number
Order index of the playlist

required
allOf
User who created the playlist

object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
required
allOf
Images associated with the playlist

object
uid: PlaylistImagesOutputDTO
array<object>
Original images and thumbnail previews

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags linked to the playlist

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

likesCount
required
number
Total number of likes for this playlist

dislikesCount
required
number
Total number of dislikes for this playlist

required
allOf
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Consists of:
number
uid: ReactionValue
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
object
uid: PlaylistCreatedEventPayload
required
object
uid: PlaylistResource
id
required
string
Unique identifier of the playlist

type
required
string
Resource type (should be "playlists")

required
object
uid: PlaylistAttributes
title
required
string
Title of the playlist

description
required
string
Description of the playlist

addedAt
required
string
format: date-time
Date and time when the playlist was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the playlist was last updated (ISO 8601)

order
required
number
Order index of the playlist

required
allOf
User who created the playlist

object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
required
allOf
Images associated with the playlist

object
uid: PlaylistImagesOutputDTO
array<object>
Original images and thumbnail previews

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags linked to the playlist

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

likesCount
required
number
Total number of likes for this playlist

dislikesCount
required
number
Total number of dislikes for this playlist

required
allOf
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Consists of:
number
uid: ReactionValue
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: PlaylistCreatedEvent
type
required
string
Allowed values:
"tracks.playlist-created"
required
object
uid: PlaylistCreatedEventPayload
required
object
uid: PlaylistResource
id
required
string
Unique identifier of the playlist

type
required
string
Resource type (should be "playlists")

required
object
uid: PlaylistAttributes
title
required
string
Title of the playlist

description
required
string
Description of the playlist

addedAt
required
string
format: date-time
Date and time when the playlist was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the playlist was last updated (ISO 8601)

order
required
number
Order index of the playlist

required
allOf
User who created the playlist

object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
required
allOf
Images associated with the playlist

object
uid: PlaylistImagesOutputDTO
array<object>
Original images and thumbnail previews

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags linked to the playlist

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

likesCount
required
number
Total number of likes for this playlist

dislikesCount
required
number
Total number of dislikes for this playlist

required
allOf
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Consists of:
number
uid: ReactionValue
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: PlaylistUpdatedEventPayload
required
object
uid: PlaylistResource
id
required
string
Unique identifier of the playlist

type
required
string
Resource type (should be "playlists")

required
object
uid: PlaylistAttributes
title
required
string
Title of the playlist

description
required
string
Description of the playlist

addedAt
required
string
format: date-time
Date and time when the playlist was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the playlist was last updated (ISO 8601)

order
required
number
Order index of the playlist

required
allOf
User who created the playlist

object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
required
allOf
Images associated with the playlist

object
uid: PlaylistImagesOutputDTO
array<object>
Original images and thumbnail previews

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags linked to the playlist

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

likesCount
required
number
Total number of likes for this playlist

dislikesCount
required
number
Total number of dislikes for this playlist

required
allOf
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Consists of:
number
uid: ReactionValue
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
object
uid: PlaylistUpdatedEvent
type
required
string
Allowed values:
"tracks.playlist-updated"
required
object
uid: PlaylistUpdatedEventPayload
required
object
uid: PlaylistResource
id
required
string
Unique identifier of the playlist

type
required
string
Resource type (should be "playlists")

required
object
uid: PlaylistAttributes
title
required
string
Title of the playlist

description
required
string
Description of the playlist

addedAt
required
string
format: date-time
Date and time when the playlist was added (ISO 8601)

updatedAt
required
string
format: date-time
Date and time when the playlist was last updated (ISO 8601)

order
required
number
Order index of the playlist

required
allOf
User who created the playlist

object
uid: UserRef
id
required
string
Unique identifier of the user

name
required
string
Name of the user

Additional properties are allowed.
required
allOf
Images associated with the playlist

object
uid: PlaylistImagesOutputDTO
array<object>
Original images and thumbnail previews

required
allOf
Type of the image size (e.g., original, thumbnail variants)

Consists of:
string
uid: ImageSizeType
Type of the image size (e.g., original, thumbnail variants)

Allowed values:
"original"
"thumbnail"
"medium"
width
required
number
Image width in pixels

height
required
number
Image height in pixels

fileSize
required
number
Image file size in bytes

url
required
string
Full public URL of the image

Additional properties are allowed.
required
array<object>
Tags linked to the playlist

id
required
string
Unique identifier of the tag

name
required
string
Original name of the tag

likesCount
required
number
Total number of likes for this playlist

dislikesCount
required
number
Total number of dislikes for this playlist

required
allOf
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Consists of:
number
uid: ReactionValue
User reaction: 0 – guest or no reaction; 1 – like; -1 – dislike

Allowed values:
0
1
-1
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.
Additional properties are allowed.

Musicfun WebSocket API 1.0

Servers

Security:

Operations

PUB tracks.track-published

Examples

This example has been generated automatically.

PUB tracks.track-added-to-playlist

Examples

This example has been generated automatically.

PUB tracks.track-liked

Examples

This example has been generated automatically.

PUB tracks.track-image-processed

Examples

This example has been generated automatically.

PUB tracks.playlist-image-processed

Examples

This example has been generated automatically.

PUB tracks.playlist-created

Examples

This example has been generated automatically.

PUB tracks.playlist-updated

Examples

This example has been generated automatically.

Schemas