PUT Reencode Audio

Overview

---

The following table contains information about the PUT method in regards for managing the process of reeoncoding a specific audio.

PUT Reencode Audio
Method	PUT
URL or Endpoint	/api/v1/projectId/audios/audioId
Headers	Authorization
Parameters	audioId, projectId
Body	Check the request body below.

The description of the URL parameter is as follows:

audioId Parameter
URL Parameter Name	audioId
Mandatory	Yes
Type	string
Description	Unique Id of the audio.

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

Request Body

{
  "downloadUrl": "string",
  "callBackUrl": "string",
  "hasDrm": true,
  "folderId": 0,
  "title": "string",
  "author": "string",
  "enableDuplicateCheck": true,
  "uploadFileDetailsId": 0
}

Information about the fields that appear on the request body are displayed in the table below.

Parameter Name	Mandatory	Type	Description
downloadUrl	Yes	string	URL to download the audio
callBackUrl	No	string	URL for callback after processing
hasDrm	No	bool	Indicates if DRM is enabled
folderId	No	integer($int32)	Identifier of the folder
title	No	string	Title of the audio.
author	No	string	Author of the audio.
enableDuplicateCheck	No	boolean	Determines whether duplicate audios should be disallowed.
uploadFileDetailsId	No	integer($int32)	The ID of upload file details.

Response

{
  "success": true,
  "errors": [],
  "messages": [],
  "result": {
    "name": "{audioId}",
    "originalFile": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/mp3/128kbps.mp3"
  },
  "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[string]	Indicates if there was an error
messages	array[string]	Returns the response message from back-end
result	array[Object]	Returns the response object
name	string	Unique identifier of the audio
originalFile	string	URL of the original audio file
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