Media Interactions are Part of the Frontend API. They describe the Interaction between an existing Media Item and a User (who can be anonymous in certain Cases). Media Interactions need a valid Session (and most of them also a valid, loggedin User) to be processed.
Common Interactions
POST https://api.nexx.cloud/v3.1/interactions/addcomment
Query Parameters
if the Comment is a Reply to another Comment, the parent Comment ID
if the User is anonymous, the given Username
if related to a nexxPLAY Delivery, the current Media Timestamp
the ID of the currently active Item - if the target Streamtype is a Container Streamtype.
POST https://api.nexx.cloud/v3.1/interactions/addrate
Query Parameters
if related to a nexxPLAY Delivery, the current Media Timestamp
the ID of the currently active Item - if the target Streamtype is a Container Streamtype.
POST https://api.nexx.cloud/v3.1/interactions/addreaction
Query Parameters
the Reaction itself [haha, love, shock, sad, angry]
if related to a nexxPLAY Delivery, the current Media Timestamp
the ID of the currently active Item - if the target Streamtype is a Container Streamtype.
POST https://api.nexx.cloud/v3.1/interactions/addlike
Query Parameters
if related to a nexxPLAY Delivery, the current Media Timestamp
the ID of the currently active Item - if the target Streamtype is a Container Streamtype.
/addtofavourites
POST https://api.nexx.cloud/v3.1/interactions/addtofavourites
Query Parameters
if related to a nexxPLAY Delivery, the current Media Timestamp
the ID of the currently active Item - if the target Streamtype is a Container Streamtype.
/addtowatchlist
POST https://api.nexx.cloud/v3.1/interactions/addtowatchlist
Query Parameters
POST https://api.nexx.cloud/v3.1/interactions/addtocart
Query Parameters
/expressinterest
POST https://api.nexx.cloud/v3.1/interactions/expressinterest
Query Parameters
an optional Message, given by the User
if related to a nexxPLAY Delivery, the current Media Timestamp
the ID of the currently active Item - if the target Streamtype is a Container Streamtype.
DELETE https://api.nexx.cloud/v3.1/interactions/removecomment
Query Parameters
DELETE https://api.nexx.cloud/v3.1/interactions/removerate
Query Parameters
DELETE https://api.nexx.cloud/v3.1/interactions/removelike
Query Parameters
/removereaction
DELETE https://api.nexx.cloud/v3.1/interactions/removereaction
Query Parameters
/removefromfavourites
DELETE https://api.nexx.cloud/v3.1/interactions/removefromfavourites
Query Parameters
/removefromwatchlist
DELETE https://api.nexx.cloud/v3.1/interactions/removefromwatchlist
Query Parameters
/removefromcart
DELETE https://api.nexx.cloud/v3.1/interactions/removefromcart
Query Parameters
Advanced Interactions
POST https://api.nexx.cloud/v3.1/interactions/addtowatched
This Methods fills the serverside Watch History of a User. The User must be loggedin for this Method. Besides non-Player Media Types, this Method should only be called by nexxPLAY directly.
Query Parameters
the Reason for Playback on a Pay Element
the parent Streamtype, if available
the parent Media ID, if available
set to 1, if the Playback was a Pay Preview
set to 1, if Media is a Bumper
set to 1, if Media started muted
set to 1, if the Playback happend on a locally downloaded Item
POST https://api.nexx.cloud/v3.1/interactions/flagcomment
Query Parameters
POST https://api.nexx.cloud/v3.1/interactions/finishcart
Query Parameters
an optional Name for the current Cart
POST https://api.nexx.cloud/v3.1/interactions/joinevent
Query Parameters
the ID of the Event to join
POST https://api.nexx.cloud/v3.1/interactions/jointeam
Query Parameters
the ID of the Team to join
DELETE https://api.nexx.cloud/v3.1/interactions/unjoinevent
Query Parameters
the ID of the Event to leave
DELETE https://api.nexx.cloud/v3.1/interactions/unjointeam
Query Parameters
the ID of the Team to leave
/removefromhistory
DELETE https://api.nexx.cloud/v3.1/interactions/removefromhistory
Query Parameters
/registerclickedlink
POST https://api.nexx.cloud/v3.1/interactions/registerclickedlink
Query Parameters
POST https://api.nexx.cloud/v3.1/interactions/createclip
Query Parameters
the desired Start of the new Scene
the desired End of the new Scene
/preparedownload
POST https://api.nexx.cloud/v3.1/interactions/preparedownload
Query Parameters
/prepareofflinedownload
POST https://api.nexx.cloud/v3.1/interactions/prepareofflinedownload
This Method needs a valid Session, that has been created in an App Context.
Query Parameters
the desired Protection [drm, plain]
the Way the Download was started [sdk, media]
/finishofflinedownload
POST https://api.nexx.cloud/v3.1/interactions/finishofflinedownload
This Method needs a valid Session, that has been created in an App Context.
Query Parameters
the Operation ID from the prepareofflinedownload Method
the received Size of the File
/removeofflinedownload
DELETE https://api.nexx.cloud/v3.1/interactions/removeofflinedownload
This Method needs a valid Session, that has been created in an App Context.
Query Parameters
Template Interactions
POST https://api.nexx.cloud/v3.1/interactions/sendform
All Form Elements, that are marked as mandatory must be sent via POST Parameters, as filled out by the User.
Query Parameters
the ID of an existing nexxOMNIA File
POST https://api.nexx.cloud/v3.1/interactions/sendpoll
As the Poll can be canceled anytime, the Result here is a Key/Value Object with the Question ID as Key and the User Input as value. JSON encode this Object and send it via the "result" Parameter.
Query Parameters
JSON encoded Set of current Result
POST https://api.nexx.cloud/v3.1/interactions/sendvoting
Query Parameters
