Skip to main content

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
MethodPOST
URL or Endpoint/api/v1/projectId/live-videos/thumbnail
HeadersAuthorization
Content Typemultipart/form-data
ParametersprojectId
Request BodyvideoId, Folder, File

The description of the URL parameter is as follows:

projectId URL Parameter
URL Parameter NameprojectId
MandatoryYes
Typestring
DescriptionUnique Id of the project.

Request Body

The description of the body parameters is as follows:

Parameter NameMandatoryTypeDescription
videoIdYesstringUnique identifier of the live video
FolderNostringName or path of the folder
FileNostring($binary)The thumbnail image of the video should be in binary format

Response

{
"success": true,
"errors": [
"string"
],
"messages": [
"string"
],
"result": {
"id": "string",
"path": "string",
"relativePath": "string",
"blobPath": "string"
},
"resultInfo": "string",
"statusCode": 0
}

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

Field NameTypeDescription
successboolIf the response is successful it will return true. Otherwise will return false.
errorsarray[]Indicates if there was an error.
messagesarray[]Returns the response message from back-end.
resultarray[Object]Returns the response object.
idstringReturns the unique identifier of specific live video
pathstringReturns the URL path where the thumbnail image of the video can be accessed
relativePathstringReturns the relative path
blobPathstringReturns the blob path
resultInfostringReturns extra information about the result.
statusCodeinteger($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