GET Video Template
Overview
The following table contains important information about the GET
method in regards to receiving the video template.
GET Video Template | |
---|---|
Method | GET |
URL or Endpoint | /video/videoId /playerId |
Headers | Authorization |
Parameters | videoId, playerId |
Body | Not Applicable |
The description of the URL parameters is as follows:
URL Parameter Name | Mandatory | Type | Description |
---|---|---|---|
videoId | Yes | string | Unique Id of the video. |
playerId | Yes | string | Unique 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 Name | Type | Description |
---|---|---|
videoId | string | The id of the video. |
file | string | The URL of the video. |
thumbnail | string | The URL of the thumbnail. |
filmstrip | string | The URL of the filmstrip. |
live | bool | Indicates whether the video is live. |
liveType | string | A string - realtime, slowtv, etc. |
autoRelated | string | Indicates if the video is auto related. |
related | string | Indicates what the video is related to. |
tracks | array | Returns the tracks as an array. |
adId | string | The id of the ad. |
startTime | integer($int32) | Indicates the starting time of the ad in seconds. |
advertising | bool | Indicates whether advertising is enabled for the video. |
ads | Object | Returns the ad as an object. |
vmap | string | The VMAP of the ad. |
VPAIDmode | string | The VPAID mode of the ad. |
adBreaks | array[Object] | Returns the ad breaks as an array of objects. |
bidding | bool | Indicates whether bidding is enabled. |
bidders | array[Object] | Returns the bidders as an array of objects. |
playlist | Object | Returns the playlist as an object. |
state | false | Indicates the state of the playlsit. |
playlistId | string | The id of the playlist. |
playtlistVideoIndex | integer($int32) | Indicates the video index of the playlist. |
algorithm | string | The algorithm of the playlist. |
skipIntro | Object | Returns the skipIntro as an object. |
state | bool | Indicates the state of the skipIntro object. |
skipFrom | integer($int32) | Indicates the time of the video to skip from. |
skipTo | integer($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