GET Live Video Details

Overview

---

The table below provides key details about the GET method for receiving Live Video Details.

GET Live Video Details
Method	GET
URL or Endpoint	/api/v1/projectId/live-videos/id
Headers	Authorization
Parameters	id, projectId
Body	Not Applicable

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter Name	Id
Mandatory	Yes
Type	string
Description	Unique Id of the live video.

projectId URL Parameter
URL Parameter Name	projectId
Mandatory	Yes
Type	string
Description	Unique Id of the project.

Request body

The request does not contain the request body

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "publicId": "{videoId}",
    "name": null,
    "title": "{title}",
    "description": "{description}",
    "thumbnail": "https://cdn.vpplayer.tech/{projectId}/images/{thumbnail}/live-thumbnail.jpg",
    "playbackUrl": "https://cdn.vpplayer.tech/{projectId}/hub/{thumbnail}/index.m3u8",
    "channelPublicId": "{channelId}",
    "channelName": "{channelName}",
    "channelTitle": "{channelTitle}",
    "channelLogo": null,
    "type": "Standard",
    "latencyType": "Normal",
    "liveStatus": "Offline",
    "canGoLive": false,
    "isLiveStreaming": true,
    "canStopAndCut": true,
    "startDateUTC": "2024-05-23T20:09:29.8106349",
    "endDateUTC": null,
    "publishDate": null,
    "publishEndDate": null,
    "geoBlockingRuleId": 194,
    "author": "{author}",
    "activeChannelId": "{channelId}",
    "tags": [],
    "hasGeoRestriction": true,
    "geoRestrictionLink": "https://livestream.vp.gjirafa.tech/api/v1/{projectId}/live-videos/{videoId}/secure-link"
  },
  "resultInfo": null,
  "statusCode": 200
}

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

Field Name	Type	Description
success	bool	If the response is successful, it will return true. Otherwise, it will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from the back-end.
result	array[Object]	Returns the response object.
publicId	string	Returns the public identifier of the live video.
name	string	Returns a guid that is randomly generated.
title	string	Returns the title of the live video.
description	string	Returns the description of the live video.
thumbnail	string	Returns the URL for the live video's thumbnail.
playbackUrl	string	Returns a file URL where the livestream can be accessed for playback.
channelPublicId	string	Returns the public identifier of the channel.
channelName	string	Returns the name of the channel.
channelTitle	string	Returns the title of the channel.
channelLogo	string	Returns the URL of the channel's logo.
type	string	Returns ingestion type of RTMP (Real Time Messaging Protocol).
latencyType	string	Returns the type of latency chosen during the creation of the channel.
liveStatus	string	Indicates the live status of the live video.
canGoLive	bool	Indicates if the video is ready to go live.
isLiveStreaming	bool	Indicates if the video is currently live streaming.
canStopAndCut	bool	Returns a value indicating if the video can be stopped and cut.
startDateUTC	string($date-time)	Indicates the start date and time when the video was created.
endDateUTC	string($date-time)	Indicates the end date and time when the video will no longer be accessible.
publishDate	string($date-time)	Returns the date and time when the video will become accessible.
publishEndDate	string($date-time)	Indicates the end date and time when the video will no longer be accessible.
author	string	Returns the author of the live video.
activeChannelId	string	Returns the unique identifier of the active channel.
tags	array[]	Returns an array of tags.
geoBlockingRuleId	integer($int32)	Returns the identifier for the geo-blocking rule.
hasGeoRestriction	boolean	Indicates whether geo-restriction is applied to the video.
geoRestrictionLink	string	Returns the link for geo-restricted access to the video.
resultInfo	string	Returns extra information about the result.
statusCode	integer($int32)	Returns the HTTP Status Code.

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