Skip to main content

GET Audios for a specific Podcast

Overview


The following table contains information about the GET method for managing the process of retrieving audios from a specific podcast.

GET Audios for a specific Podcast
MethodGET
URL or Endpoint/api​/v1/projectIdpodcasts/id/audios
Parametersid, projectId
BodyNot Applicable

The description of the URL parameters is as follows:

URL Parameter NameMandatoryTypeDescription
IdYesstringUnique Id of the podcast.
URL Parameter NameMandatoryTypeDescription
projectIdYesstringUnique Id of the project.

Request Body

This method does not require the request body.

Response


{
"success": true,
"errors": [],
"messages": [],
"result": [
{
"mediaId": "{audioId}",
"title": "{title}",
"thumbnailUrl": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/thumbnails/retina.jpg",
"duration": 93.727347,
"durationString": "01:33",
"hlsUrl": "https://cdn.vpplayer.tech/{projectId}/audio-encode/{audioId}/hls/master_file.m3u8"
}
],
"resultInfo": null,
"statusCode": 200
}

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, it will return false.
errorsarray[string]Indicates if there was an error.
messagesarray[string]Returns the response message from the backend.
resultobjectReturns the response object containing the detailed result.
mediaIdstringThe identifier for the audio.
titlestringThe title of the audio.
thumbnailUrlstringThe URL for the thumbnail image of the audio.
durationfloatThe duration of the audio in seconds.
durationStringstringThe duration of the audio formatted as a string.
hlsUrlstringThe URL for the HLS version of the audio.
resultInfoobjectAdditional information about the result.
statusCodeintegerThe HTTP status code of the response.

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