DovaFM Documentation
WebsiteAdd Discord Bot
  • Welcome to the DovaFM Documentation!
  • DovaFM Stream
    • Embed Widgets
    • Public Pages
    • Radio & Playlist Streams
  • DovaFM API
    • Now Playing
    • Stations
      • General
      • Broadcasting
      • Song Requests
      • Service Control
      • History
      • HLS Streams
      • Listeners
      • Schedules
      • Media
      • Mount Points
      • Playlists
      • Podcasts
      • Queue
      • Remote Relays
      • SFTP Users
      • Streamers/DJs
      • Web Hooks
    • Administration
      • Custom Fields
      • Users
      • Relays
      • Roles
      • Settings
      • Stations
      • Storage Locations
      • CPU Status
    • Miscellaneous
      • Status
      • Time
  • DovaFM Discord Bot
    • Information
    • Commands
  • DovaFM Staff
    • Staff Members
Powered by GitBook
On this page
  1. DovaFM API
  2. Stations

Streamers/DJs

PreviousSFTP UsersNextWeb Hooks

Last updated 7 months ago

get

Retrieve details for a single Streamer/DJ account.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
idinteger · int64Required

Streamer ID

Responses
200
Success
application/json
Responseall of

Station streamers (DJ accounts) allowed to broadcast to a station.

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}/streamer/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
{
  "id": 1,
  "streamer_username": "dj_test",
  "streamer_password": "",
  "display_name": "Test DJ",
  "comments": "This is a test DJ account.",
  "is_active": true,
  "enforce_schedule": false,
  "reactivate_at": 1609480800,
  "schedule_items": []
}
delete

Delete a single Streamer/DJ account.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
idinteger · int64Required

StationStreamer 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}/streamer/{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>"
}
  • GET/station/{station_id}/streamers
  • POST/station/{station_id}/streamers
  • GET/station/{station_id}/streamer/{id}
  • PUT/station/{station_id}/streamer/{id}
  • DELETE/station/{station_id}/streamer/{id}
get

List all current Streamer/DJ accounts for the specified station.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
Responses
200
Success
application/json
Responseall of[]

Station streamers (DJ accounts) allowed to broadcast to a station.

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}/streamers HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Accept: */*
[
  {
    "id": 1,
    "streamer_username": "dj_test",
    "streamer_password": "",
    "display_name": "Test DJ",
    "comments": "This is a test DJ account.",
    "is_active": true,
    "enforce_schedule": false,
    "reactivate_at": 1609480800,
    "schedule_items": []
  }
]
post

Create a new Streamer/DJ account.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
Body
all ofOptional

Station streamers (DJ accounts) allowed to broadcast to a station.

Responses
200
Success
application/json
Responseall of

Station streamers (DJ accounts) allowed to broadcast to a station.

403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
post
POST /api/station/{station_id}/streamers HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "id": 1,
  "streamer_username": "dj_test",
  "streamer_password": "",
  "display_name": "Test DJ",
  "comments": "This is a test DJ account.",
  "is_active": true,
  "enforce_schedule": false,
  "reactivate_at": 1609480800,
  "schedule_items": []
}
{
  "id": 1,
  "streamer_username": "dj_test",
  "streamer_password": "",
  "display_name": "Test DJ",
  "comments": "This is a test DJ account.",
  "is_active": true,
  "enforce_schedule": false,
  "reactivate_at": 1609480800,
  "schedule_items": []
}
put

Update details of a single Streamer/DJ account.

Authorizations
Path parameters
station_idany ofRequired
integer · int64Optional
or
string · stringOptional
idinteger · int64Required

Streamer ID

Body
all ofOptional

Station streamers (DJ accounts) allowed to broadcast to a station.

Responses
200
Success
application/json
403
Access denied.
application/json
404
Record not found.
application/json
500
A generic exception has occurred.
application/json
put
PUT /api/station/{station_id}/streamer/{id} HTTP/1.1
Host: listen.dovafm.xyz
X-API-Key: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 215

{
  "id": 1,
  "streamer_username": "dj_test",
  "streamer_password": "",
  "display_name": "Test DJ",
  "comments": "This is a test DJ account.",
  "is_active": true,
  "enforce_schedule": false,
  "reactivate_at": 1609480800,
  "schedule_items": []
}
{
  "success": true,
  "message": "Changes saved successfully.",
  "formatted_message": "<b>Changes saved successfully.</b>"
}