getVodOffer

This method is used to get detailed information about a VOD offer by its videoId.

📘

You can try that method by clicking here

Parameters

NameTypeDescription
publisherToken*stringYou can find your publisher token at api-keys page.
offerIdString*stringID of the offer

Result Parameters

NameTypeDescription
idstringID of the offer
titlestringOffer name
descriptionstringOffer description
urlstringLink to the offer
pricestringOffers price
videoIdstringUnique identifier of your video asset
rentalPeriodstringRental period
publisherEmailstringContact email to the publisher
playerCodestringPlayer's embed code
playerCodeHeadstringPlayer's head code
streamingPlatformstringStreaming platform, e.g. YouTube
runtimestringVideo duration time
videoQualitystringVideo quality, e.g. 4k
backgroungImageUrlarrayArray of urls to backgroung image in different sizes
-smallstring
-mediumstring
-largestring
eventAssociationarrayArray of associated events
geoRestrictionEnabledboolean'true' if the offer is georesctricted
geoRestrictionTypestringChoose type of geo-restriction: whitelist / blacklist
geoRestrictionCountriesarrayBased on geoRestrictionType, set the array of whitelisted/blacklisted countries
membershipOnlybooleanIf 'true', the offer can be only accessed by a subscription and cannot be purchased directly
createdAtintegerUnix timestamp
updatedAtintegerUnix timestamp
tagsarrayArray of Offers tags

API Request/Response

Request

{
    "method": "getVodOffer",
    "params": {
      "publisherToken": "OchFjisda123sa0OZOdYVEkLJXz8UTex7EhkCbBYbjQwthIpl",
      "offerIdString": "A371234349_PL"
    },
    "jsonrpc": "2.0",
    "id": 1
}

Response

{
    "result": {
      "vod": {
        "id": "A371234349_PL",
        "title": "Test Vod2",
        "description": "test vod offer2",
        "url": "testvod.cleeng.com",
        "price": "10.5691",
        "videoId": null,
        "rentalPeriod": 0,
        "publisherEmail": "[email protected]",
        "playerCode": "playercode",
        "playerCodeHead": "",
        "streamingPlatform": null,
        "runtime": "3321",
        "videoQuality": "4k",
        "backgroundImageUrl": {
          "small": "cleeng.com\/pic1.jpg",
          "medium": "cleeng.com\/pic1.jpg",
          "large": "cleeng.com\/pic1.jpg"
        },
        "eventAssociation": [
          
        ],
        "geoRestrictionEnabled": false,
        "geoRestrictionType": null,
        "geoRestrictionCountries": [
          
        ],
        "membershipOnly": false,
        "createdAt": 1514897470,
        "updatedAt": 1514898514,
        "tags": [
          "vod",
          "olympics"
        ]
      }
    },
    "id": "1",
    "jsonrpc": "2.0"
}