Skip to main content

GET Video Template

Overview


The following table contains important information about the GET method in regards to receiving the video template.

GET Video Template
MethodGET
URL or Endpoint/video​/videoId​/playerId
HeadersAuthorization
ParametersvideoId, playerId
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
videoIdYesstringUnique Id of the video.
playerIdYesstringUnique id of the player.

Request Body

The request does not contain a request body

Response

{
"videoId": "vjsmxlol",
"file": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibk/hls/master_file.m3u8",
"thumbnail": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibk/thumbnails/retina.jpg",
"filmstrip": "https://vp-dev.gjirafa.net/vps/prod/odgehtyo/encode/vjsmxibk/thumbnails/filmstrip0.jpg",
"live": false,
"liveType": "",
"autoRelated": "",
"related": "",
"tracks": [],
"adId": "smyrfdkt",
"startTime": 0,
"advertising": true,
"ads": {
"vmap": null,
"VPAIDmode": null,
"adBreaks": [],
"bidding": false,
"bidders": []
},
"playlist": {
"state": false,
"playlistId": "",
"playlistVideoIndex": -1,
"algorithm": ""
},
"skipIntro": {
"state": true,
"skipFrom": 7,
"skipTo": 31
}
}

Information about the fields that appear when you receive the response are displayed in the table below.

Field NameTypeDescription
videoIdstringThe id of the video.
filestringThe URL of the video.
thumbnailstringThe URL of the thumbnail.
filmstripstringThe URL of the filmstrip.
liveboolIndicates whether the video is live.
liveTypestringA string - realtime, slowtv, etc.
autoRelatedstringIndicates if the video is auto related.
relatedstringIndicates what the video is related to.
tracksarrayReturns the tracks as an array.
adIdstringThe id of the ad.
startTimeinteger($int32)Indicates the starting time of the ad in seconds.
advertisingboolIndicates whether advertising is enabled for the video.
adsObjectReturns the ad as an object.
vmapstringThe VMAP of the ad.
VPAIDmodestringThe VPAID mode of the ad.
adBreaksarray[Object]Returns the ad breaks as an array of objects.
biddingboolIndicates whether bidding is enabled.
biddersarray[Object]Returns the bidders as an array of objects.
playlistObjectReturns the playlist as an object.
statefalseIndicates the state of the playlsit.
playlistIdstringThe id of the playlist.
playtlistVideoIndexinteger($int32)Indicates the video index of the playlist.
algorithmstringThe algorithm of the playlist.
skipIntroObjectReturns the skipIntro as an object.
stateboolIndicates the state of the skipIntro object.
skipFrominteger($int32)Indicates the time of the video to skip from.
skipTointeger($int32)Indicates the time of the video to skip to.

If the action is successful, the service sends back an HTTP 200 or 201 response.

Errors

For information about the errors that are common to all actions, see Common Errors:

  • HTTP Status Code 400: Bad Request

  • HTTP Status Code 401: Unauthorized

  • HTTP Status Code 403: Forbidden

  • HTTP Status Code 404: Result Not Found

  • HTTP Status Code 500: Internal Server Error

  • HTTP Status Code 503: Backend Fetch Failed