This method lets you create a VOD offer via Cleeng API.
Name Type Description publisherToken* string You can find your publisher token at api-keys page. offerData* object All data describing new offer. -price float Offer price (in publisher's currency), value between 0.14 and 99.99 -title string Title of the offer, up to 70 chars. -url string Url to your content. -description* string Additional offer description, up to 110 chars -videoId* string Unique identifier of your video asset -playerCode* string Player's embed code -playerCodeHead* string Player's head code -rentalPeriod* string Rental period -runtime* string Video duration time -videoQuality* string Video quality, e.g. 4k -backgroundImageUrl* string Url to background image -eventAssociation* array Array of offer Id of live events which access should be transferred on this VOD -tags* array Tags attached to offer -geoRestrictionEnabled* bool Set "true" to enable geo-restriction on this offer -geoRestrictionType* string Choose type of geo-restriction: whitelist / blacklist -geoRestrictionCountries* array Based on geoRestrictionType, set the array of whitelisted/blacklisted countries.
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
JSON
{
"method": "createVodOffer",
"params": {
"publisherToken": "OchFjivBxu8SAD21ZOdYVEkLJXz8UTex7EhkCbBY22Qwwespl",
"offerData": {
"price": "21.00",
"title": "Test Vod",
"url": "testvod.cleeng.com",
"description": "test vod offer",
"playerCode": "<iframe>playercode<\/iframe>",
"runtime": "3600",
"videoQuality": "4k",
"eventAssociation": [
],
"tags": [
"vod",
"sport"
],
"geoRestrictionCountries": [
]
}
},
"jsonrpc": "2.0",
"id": 1
}JSON
{
"result": {
"vod": {
"id": "A376123349_PL",
"title": "Test Vod",
"description": "test vod offer",
"url": "testvod.cleeng.com",
"price": "17.0731",
"videoId": null,
"rentalPeriod": 0,
"publisherEmail": "[email protected] ",
"playerCode": "playercode",
"playerCodeHead": "",
"streamingPlatform": null,
"runtime": "3600",
"videoQuality": "4k",
"backgroundImageUrl": {
"small": null,
"medium": null,
"large": null
},
"eventAssociation": [
],
"geoRestrictionEnabled": false,
"geoRestrictionType": null,
"geoRestrictionCountries": [
],
"membershipOnly": false,
"createdAt": 1514897470,
"updatedAt": 1514897470,
"tags": [
"sport",
"vod"
]
}
},
"id": "1",
"jsonrpc": "2.0"
}
