Media Export Management
With the Media Export Management Endpoints, it is possible to manage the Lifecycle of nexxOMNIA Media Items on 3rd Party Platforms. Additionally, for Sharing and Review Processes, the Preview Links are manageable here.
External Platforms
/export
POST https://api.nexx.cloud/v3.1/manage/:streamtype/:item/export
An Export physically transfers the Media Item to the 3rd Party Plaform. Supported are only the Streamtypes "video", "live", "image" and "scene". Supported Accounts are Accounts of Type [youtube, facebook, instagram, vimeo, twitter, tiktok]
Path Parameters
streamtype
string
the Streamtype of the target Item
item
number
the target Item ID
Request Body
account
integer
the ID of a valid Domain Account
externalCategory
string
the ID/Name of the Category of the 3rd Party Platform - necessary for Facebook and YouTube (but can be set on the Media Item directly too)
externalState
string
[public, unlisted, private] the State of the new Item on the 3rd Party Platform
publicationDate
integer
UNIX Timestamp for the Publication Date on the 3rd Party Platform. If used, externalState must be "private".
inVariant
number
If the Export should use an existing Variant, add the Variant ID here.
postText
string
As Mastodon, Threads and Instagram only supports "posts", add an (optional) Posting Text here, if the Target Platform is Mastodon, Threads or Instagram.
list
integer
the ID of a valid Playlist in the given Account
platformContext
string
[default, reel, short, story] if Streamtype and Platform support it, add a hint on how to present the Media on the target Platform
metadataLanguage
string
optional Language for Metadata and Covers, in case the Domain uses multiple Languages
/exportaspost
POST https://api.nexx.cloud/v3.1/manage/:streamtype/:item/exportaspost
An Post Export creates a Post Media Item in nexxOMNIA, while posting the given Text/Link/Image on the target Platform. Supported are all linkable Streamtypes. Supported Accounts are Accounts of Type [facebook, twitter]
Path Parameters
streamtype
string
the Streamtype of the target Item
item
number
the target Item ID
Request Body
account
integer
the ID of a valid Domain Connection (Account)
postURL
string
the URL of the Media Item on the Domain Frontend. Can be omitted, if nexxOMNIA can create the Link to the Item itself.
postText
string
the Post Text
postImage
integer
an ID of an exisiting Image within nexxOMNIA. If omitted, the Media Cover will be used as Image.
postWithLink
boolean
only needed on Streamtype "article" (see Info below).
/updateexport
PUT https://api.nexx.cloud/v3.1/manage/:streamtype/:item/updateexport
Path Parameters
streamtype
string
the Streamtype of the target Item
item
number
the target Item ID
Request Body
item
string
must be set, if externalReference is not set. item is the Export ID from nexxOMNIA
externalReference
string
must be set, if item is not set. externalReference is the ID of the Export on the 3rd Party Platform
partToUpdate
string
[all, metadata, texttracks, cover, video] what Part should be updated
/removeexport
DELETE https://api.nexx.cloud/v3.1/manage/:streamtype/:item/removeexport
Path Parameters
streamtype
string
the Streamtype of the target Item
item
number
the target Item ID
Request Body
item
string
must be set, if externalReference is not set. item is the Export ID from nexxOMNIA
externalReference
string
must be set, if item is not set. externalReference is the ID of the Export on the 3rd Party Platform
PreviewLinks
/addpreviewlink
POST https://api.nexx.cloud/v3.1/manage/:streamtype/:item/addpreviewlink
Path Parameters
streamtype
string
the Streamtype of the target Item
item
number
the target Item ID
Request Body
language
string
if set to a valid 2-Letter Language Code, the Frontend will be presented in that Language
maxStarts
integer
if set, the maximal Number of Access to this Link is limited to this Number
showAnnotations
boolean
if set to 1, the User will be able to see existing Annotations
allowAnnotations
boolean
if set to 1, the User will be able to add Annotations
allowSnapshots
boolean
if set to 1, the Player will offer a Possibility to create and download Snapshots
allowSourceDownloads
boolean
if set to 1, the Player will allow the Download of the Source Video
code
string
if set to a valid String, this will be the Code, any User has to enter before access
useDomainStyle
boolean
if set to 1, the PreviewLink UI will use the Domain Colors and Icons.
title
string
the Title of the new PreviewLink
/removepreviewlink
DELETE https://api.nexx.cloud/v3.1/manage/:streamtype/:item/removepreviewlink/:previewlinkid
Path Parameters
streamtype
string
the Streamtype of the target Item
item
string
the target Item ID
previewlinkid
number
the ID of a valid PreviewLink of this Item
DownloadLinks
/adddownloadlink
POST https://api.nexx.cloud/v3.1/manage/:streamtype/:item/adddownloadlink
Path Parameters
streamtype
string
the Streamtype of the target Item
item
number
the target Item ID
Request Body
language
string
if set to a valid 2-Letter Language Code, the Frontend will be presented in that Language
maxStarts
integer
if set, the maximal Number of Access to this Link is limited to this Number
code
string
if set to a valid String, this will be the Code, any User has to enter before ac
useDomainStyle
boolean
if set to 1, the DownloadLink UI will use the Domain Colors and Icons.
title
string
the Title of the new DownloadLink
fileType
string
if omitted or set to "source", the Source File will be downloaded. For Audio, it can be set to [mp3, aac, opus] to offer the transcoded Version in the corresponding Format. For Video, the Options depend on the Transcoding Settings (ask 3Q nexx for details)
includeTextTracks
boolean
if set to 1, the DownloadLink will also contain TextTracks of the Media Item (if available)
/removedownloadlink
DELETE https://api.nexx.cloud/v3.1/manage/:streamtype/:item/removedownloadlink/:downloadlinkid
Path Parameters
streamtype
string
the Streamtype of the target Item
item
string
the target Item ID
downloadlinkid
number
the ID of a valid DownloadLink of this Item
Last updated
Was this helpful?