Home
Tutorials
Getting started
Understanding the API
Buy Button
Custom checkout styling
Cleeng Sandbox
Getting started with Cleeng Core
Getting started with PHP SDK
Getting started with JAVA SDK
Getting started with iOS and tvOS
Getting started with Roku
Getting started with Webhooks
Identity & Access Management
Registration and login on mobiles and TV boxes via Middleware
Registration and login on the web
Entitlements using tags (Access control)
Payment processing
Payments on Apple iOS and tvOS
Payments on Android
Payments on Roku
Payments on Amazon Fire
My Account & User profile
My Account widget
Server-side account functions
Custom myaccount styling
Product & Offer management
Tagging products
Full demo app example
Subscription VOD web app - full example
Webstore SDK - flexible purchase process example
API Reference
Introduction to API
Entitlements
JAVASCRIPT
CleengApi.getAccessStatus
SERVER-SIDE
getAccessStatus
getAccessStatusForDevice
getAccessibleTags
registerSubscription
isTrialAllowed
Authorization & payments
JAVASCRIPT
CleengApi.checkout
CleengApi.autologin
CleengApi.logout
SERVER-SIDE
getPrice
getMultiCurrencyPrice
calculateSwitchPrice
extendTokenExpiration
registerCustomer
generateCustomerTokenFromPassword
listPaymentDetails
deletePaymentDetails
getConsentDefinitions
getViewerConsents
submitConsent
updateConsentDefinition
Customer & support
JAVASCRIPT
CleengApi.getCustomer
CleengApi.myAccount
SERVER-SIDE
getCustomer
getCustomerEmail
requestPasswordReset
updateCustomerEmail
updateCustomerPassword
updateCustomerSubscription
listCustomerLibrary
listCustomerSubscriptions
fetchCaptureQuestions
fetchCaptureStatus
saveCaptureQuestions
setCaptureEnabled
fetchBroadcasterSpecificPersonalDataWithCaptureAnswers
updateBroadcasterSpecificPersonalDataWithCaptureAnswers
Reporting
JAVASCRIPT
CleengApi.trackOfferImpression
SERVER-SIDE
listTransactions
listCancellations
listSubscribers
listCustomers
SSO integration
SERVER-SIDE
getLocaleDataFromIp
prepareRemoteAuth
generateCheckoutUrl
generateCustomerToken
updateCustomerEmail
updateCustomerPassword
generateMyAccountUrl
TV, Roku and console
SERVER-SIDE
getAccessStatusForDevice
generateCustomerTokenFromTransactionId
Offer management
SERVER-SIDE
Event Offers
getEventOffer
listEventOffers
createEventOffer
updateEventOffer
cancelEventOffer
Single Offers
getSingleOffer
listSingleOffers
createSingleOffer
updateSingleOffer
deactivateSingleOffer
createMultiCurrencySingleOffer
updateMultiCurrencySingleOffer
Rental Offers
getRentalOffer
listRentalOffers
createRentalOffer
updateRentalOffer
deactivateRentalOffer
createMultiCurrencyRentalOffer
updateMultiCurrencyRentalOffer
Subscriptions
getSubscriptionOffer
listSubscriptionOffers
createSubscriptionOffer
updateSubscriptionOffer
deactivateSubscriptionOffer
createMultiCurrencySubscriptionOffer
updateMultiCurrencySubscriptionOffer
Pass offers
getPassOffer
listPassOffers
createPassOffer
updatePassOffer
deactivatePassOffer
createMultiCurrencyPassOffer
updateMultiCurrencyPassOffer
VOD offers
getVodOffer
listVodOffers
createVodOffer
updateVodOffer
deactivateVodOffer
Webhooks
DOCS
Available webhook events
API METHODS
subscribeToWebhookEvent
unsubscribeFromWebhookEvent
listWebhookSubscriptions
Release Notes
Cleeng Developers
| Developers
  • Products
    • Cleeng Core
      Cleeng Core
      Video subscriber management
    • Merchant
      Merchant
      Payment & checkout optimisation
    • ChurnIQ
      ChurnIQ
      Smart & predictive churn analytics
    • Hi5
      Hi5
      Professional customer care staffing
    • Live Pay-Per-View
      Live Pay-Per-View
      Turnkey live event solution
  • Solutions
  • Developers API
  • Resources
  • Blog

getVodOffer

Home
Tutorials
Getting started
Understanding the API
Buy Button
Custom checkout styling
Cleeng Sandbox
Getting started with Cleeng Core
Getting started with PHP SDK
Getting started with JAVA SDK
Getting started with iOS and tvOS
Getting started with Roku
Getting started with Webhooks
Identity & Access Management
Registration and login on mobiles and TV boxes via Middleware
Registration and login on the web
Entitlements using tags (Access control)
Payment processing
Payments on Apple iOS and tvOS
Payments on Android
Payments on Roku
Payments on Amazon Fire
My Account & User profile
My Account widget
Server-side account functions
Custom myaccount styling
Product & Offer management
Tagging products
Full demo app example
Subscription VOD web app - full example
Webstore SDK - flexible purchase process example
API Reference
Introduction to API
Entitlements
JAVASCRIPT
CleengApi.getAccessStatus
SERVER-SIDE
getAccessStatus
getAccessStatusForDevice
getAccessibleTags
registerSubscription
isTrialAllowed
Authorization & payments
JAVASCRIPT
CleengApi.checkout
CleengApi.autologin
CleengApi.logout
SERVER-SIDE
getPrice
getMultiCurrencyPrice
calculateSwitchPrice
extendTokenExpiration
registerCustomer
generateCustomerTokenFromPassword
listPaymentDetails
deletePaymentDetails
getConsentDefinitions
getViewerConsents
submitConsent
updateConsentDefinition
Customer & support
JAVASCRIPT
CleengApi.getCustomer
CleengApi.myAccount
SERVER-SIDE
getCustomer
getCustomerEmail
requestPasswordReset
updateCustomerEmail
updateCustomerPassword
updateCustomerSubscription
listCustomerLibrary
listCustomerSubscriptions
fetchCaptureQuestions
fetchCaptureStatus
saveCaptureQuestions
setCaptureEnabled
fetchBroadcasterSpecificPersonalDataWithCaptureAnswers
updateBroadcasterSpecificPersonalDataWithCaptureAnswers
Reporting
JAVASCRIPT
CleengApi.trackOfferImpression
SERVER-SIDE
listTransactions
listCancellations
listSubscribers
listCustomers
SSO integration
SERVER-SIDE
getLocaleDataFromIp
prepareRemoteAuth
generateCheckoutUrl
generateCustomerToken
updateCustomerEmail
updateCustomerPassword
generateMyAccountUrl
TV, Roku and console
SERVER-SIDE
getAccessStatusForDevice
generateCustomerTokenFromTransactionId
Offer management
SERVER-SIDE
Event Offers
getEventOffer
listEventOffers
createEventOffer
updateEventOffer
cancelEventOffer
Single Offers
getSingleOffer
listSingleOffers
createSingleOffer
updateSingleOffer
deactivateSingleOffer
createMultiCurrencySingleOffer
updateMultiCurrencySingleOffer
Rental Offers
getRentalOffer
listRentalOffers
createRentalOffer
updateRentalOffer
deactivateRentalOffer
createMultiCurrencyRentalOffer
updateMultiCurrencyRentalOffer
Subscriptions
getSubscriptionOffer
listSubscriptionOffers
createSubscriptionOffer
updateSubscriptionOffer
deactivateSubscriptionOffer
createMultiCurrencySubscriptionOffer
updateMultiCurrencySubscriptionOffer
Pass offers
getPassOffer
listPassOffers
createPassOffer
updatePassOffer
deactivatePassOffer
createMultiCurrencyPassOffer
updateMultiCurrencyPassOffer
VOD offers
getVodOffer
listVodOffers
createVodOffer
updateVodOffer
deactivateVodOffer
Webhooks
DOCS
Available webhook events
API METHODS
subscribeToWebhookEvent
unsubscribeFromWebhookEvent
listWebhookSubscriptions
Release Notes

getVodOffer()

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

Parameters

Name Type Description
publisherToken string You can find your publisher token at api-keys page.
offerIdStringstring ID of the offer

- required parameter

Result Parameters

Name Type Description
id string ID of the offer
title string Offer name
description string Offer description
url string Link to the offer
price string Offers price
videoId string Unique identifier of your video asset
rentalPeriod string Rental period
publisherEmail string Contact email to the publisher
playerCode string Player's embed code
playerCodeHead string Player's head code
streamingPlatform string Streaming platform, e.g. YouTube
runtime string Video duration time
videoQuality string Video quality, e.g. 4k
backgroungImageUrl array Array of urls to backgroung image in different sizes
-small string
-medium string
-large string
eventAssociation array Array of associated events
geoRestrictionEnabled boolean 'true' if the offer is georesctricted
geoRestrictionType string Choose type of geo-restriction: whitelist / blacklist
geoRestrictionCountries array Based on geoRestrictionType, set the array of whitelisted/blacklisted countries
membershipOnly boolean If 'true', the offer can be only accessed by a subscription and cannot be purchased directly
createdAt integer Unix timestamp
updatedAt integer Unix timestamp
tags array Array 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": "broadcaster@domain.com",
        "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"
  }
]
GO TO API CONSOLE
Follow us
Products
  • Subscriber management system
  • Checkout optimization tool
  • Churn management system
  • Customer support system
  • Cleeng Live PPV
  • OTT Flow SVOD Extension
About
  • Company
  • Press & Media
  • Blog
  • Partners
  • Jobs
  • Industry events
Developer
  • API Reference
  • Sandbox
  • Tutorials
  • Releases
Broadcasters
  • My Dashboard
  • FAQ & Support
Viewer
  • Who is Cleeng?
  • Get Support
Copyright © 2019 Cleeng | All Rights Reserved | Terms & Conditions | Privacy
We use cookies to ensure that we provide you the best service and website experience. Read our Cookie policy for more details.