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 | |
---|---|
Method | GET |
URL or Endpoint | /api/v1/projectId podcasts/id /audios |
Parameters | id, projectId |
Body | Not Applicable |
The description of the URL parameters is as follows:
URL Parameter Name | Mandatory | Type | Description |
---|---|---|---|
Id | Yes | string | Unique Id of the podcast. |
URL Parameter Name | Mandatory | Type | Description |
---|---|---|---|
projectId | Yes | string | Unique 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 Name | Type | Description |
---|---|---|
success | bool | If the response is successful, it will return true. Otherwise, it will return false. |
errors | array[string] | Indicates if there was an error. |
messages | array[string] | Returns the response message from the backend. |
result | object | Returns the response object containing the detailed result. |
mediaId | string | The identifier for the audio. |
title | string | The title of the audio. |
thumbnailUrl | string | The URL for the thumbnail image of the audio. |
duration | float | The duration of the audio in seconds. |
durationString | string | The duration of the audio formatted as a string. |
hlsUrl | string | The URL for the HLS version of the audio. |
resultInfo | object | Additional information about the result. |
statusCode | integer | The 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