Queue | DovaFM Documentation

get

Return information about the upcoming song playback queue.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

Responses

200

Success

application/json

Responseall of[]

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

get

GET /api/station/{station_id}/queue HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

[
  {
    "cued_at": 1609480800,
    "played_at": 1609480800,
    "duration": 180,
    "playlist": "Top 100",
    "is_request": true,
    "song": {
      "text": "Chet Porter - Aluko River",
      "artist": "Chet Porter",
      "title": "Aluko River",
      "album": "Moving Castle",
      "genre": "Rock",
      "isrc": "US28E1600021",
      "lyrics": "",
      "id": "9f33bbc912c19603e51be8e0987d076b",
      "art": "https://picsum.photos/1200/1200",
      "custom_fields": [
        "custom_field_value"
      ]
    },
    "links": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "sent_to_autodj": true,
    "is_played": true,
    "autodj_custom_uri": "",
    "log": []
  }
]

get

Retrieve details of a single queued item.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

idinteger · int64Required

Queue Item ID

Responses

200

Success

application/json

Responseall of

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

get

GET /api/station/{station_id}/queue/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "cued_at": 1609480800,
  "played_at": 1609480800,
  "duration": 180,
  "playlist": "Top 100",
  "is_request": true,
  "song": {
    "text": "Chet Porter - Aluko River",
    "artist": "Chet Porter",
    "title": "Aluko River",
    "album": "Moving Castle",
    "genre": "Rock",
    "isrc": "US28E1600021",
    "lyrics": "",
    "id": "9f33bbc912c19603e51be8e0987d076b",
    "art": "https://picsum.photos/1200/1200",
    "custom_fields": [
      "custom_field_value"
    ]
  },
  "links": {
    "ANY_ADDITIONAL_PROPERTY": "text"
  },
  "sent_to_autodj": true,
  "is_played": true,
  "autodj_custom_uri": "",
  "log": []
}

delete

Delete a single queued item.

Authorizations

Path parameters

station_idany ofRequired

integer · int64Optional

or

string · stringOptional

idinteger · int64Required

Queue Item ID

Responses

200

Success

application/json

403

Access denied.

application/json

404

Record not found.

application/json

500

A generic exception has occurred.

application/json

delete

DELETE /api/station/{station_id}/queue/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*

{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}