Player Group

Create/Update a media file and play it across a player group

If you specify an existing media file id in the request body the uploaded file will overwrite that media library item. Otherwise a new media library item will be created using the uploaded file.

POST

/api/v1/group/play

curl --request POST \
  --url 'https://voyager.korbyt.com/api/v1/group/play?name=sample_group&id=1&tag=%3Cstring%3E&duration=15&start=%3Cstring%3E&end=%3Cstring%3E' \
  --header 'Authorization: Bearer <token>' \
  --form 'copyright=<string>' \
  --form 'file=<string>' \
  --form 'id=<string>' \
  --form 'name=<string>' \
  --form 'tags=[ "tag1","tag2", "tag3" ]'

[
  {
    "group_id": "11",
    "group_name": "API Group",
    "push_id": "28"
  }
]

Will preempt everything other than urgent alerts.

On success, response includes an integer push_id that can be used with the DELETE method to revoke this content assignment.

Expiration must be in the form ###m (example 10m for 10 minutes) or in UTC (2018-10-09T12:30:00Z)

Authorizations

Authorizationstringheaderrequired

Access token from POST /api/v1/auth/login

Query Parameters

namestringquery

group name or id parameters

Example: sample_group

idintegerquery

group id

Example: 1

tagstringquery

search tag

durationintegerquery

length of time to play media item

Example: 15

startstringquery

Start datetime (format: yyyy-mm-dd hh:mm:ss) player local time)

endstringquery

end datetime (format: yyyy-mm-dd hh:mm:ss) player local time)

Body

copyrightstring

filestring

media file (new or update to existing file)

idstring

specify the id if your updating existing media file

namestring

media library file name including optional folder

tagsstring

assign these tags to the new media (ignored if new media is not supplied)

Example: [ "tag1","tag2", "tag3" ]

Response

itemsobject[]

Show child attributes

Still need help? Share an idea