POST Live Video Thumbnail

Overview

---

The table below provides key details about the POST method for uploading thumbnail for Live Video.

POST Live Video Thumbnail
Method	POST
URL or Endpoint	/api/v1/projectId/live-videos/thumbnail
Headers	Authorization
Parameters	projectId
Request Body	videoId, Folder, File

The description of the URL parameter is as follows:

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

Request Body

The description of the body parameters is as follows:

Parameter Name	Mandatory	Type	Description
videoId	Yes	string	Unique identifier of the live video
Folder	No	string	Name or path of the folder
File	No	string($binary)	URL of the thumbnail image for the video

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "id": "{videoId}",
    "path": "https://cdn.vpplayer.tech/{projectId}/live-videos/{videoId}/thumbnails/{thumbnailName}.webp",
    "relativePath": null,
    "blobPath": null
  },
  "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 will return false.
errors	array[]	Indicates if there was an error.
messages	array[]	Returns the response message from back-end.
result	array[Object]	Returns the response object.
id	string	Returns the unique identifier of specific live video
path	string	Returns the URL path where the thumbnail image of the video can be accessed
relativePath	string	Returns the relative path
blobPath	string	Returns the blob path
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