Skip to content

Latest commit

 

History

History
75 lines (46 loc) · 36.6 KB

File metadata and controls

75 lines (46 loc) · 36.6 KB
id chapter-reciter-audio-files
title List of all chapter audio files of a reciter
description Get list of chapters' audio files of a reciter.
sidebar_label List of all chapter audio files of a reciter
hide_title true
hide_table_of_contents true
api
tags description operationId parameters responses method path servers security securitySchemes info postman
Audio
Get list of chapters' audio files of a reciter.
chapter-reciter-audio-files
name in description required schema
reciter_id
path
Chapter-reciter ID from [/resources/chapter_reciters](/docs/content_apis_versioned/chapter-reciters). Do not use ayah-by-ayah recitation IDs from [/resources/recitations](/docs/content_apis_versioned/recitations) here.
true
type
number
200 400 401 403 404 422 429 500 502 503 504
description content
Successful response
application/json
schema example
required type properties
audio_files
object
audio_files
type items
array
title type properties example required
Chapter Recitation
object
id chapter_id file_size format audio_url
type description
integer
The Id of the audio file
type description
integer
The chapter id
type description
integer
The file size in bytes
type description
string
The format of the file
type description
string
The audio file's url
id chapter_id file_size format audio_url
1
1
710784
mp3
id
chapter_id
file_size
format
audio_url
audio_files
id chapter_id file_size format audio_url
43
22
19779712
mp3
id chapter_id file_size format audio_url
87
44
6453376
mp3
description content
Will be returned when the request is invalid e.g. request is missing required headers or with invalid query parameters.
application/json
schema example
title type properties
invalidRequestResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
The request is missing required headers or is invalid
invalid_request
false
description content
Will be returned when the request is unauthorized.
application/json
schema example
title type properties
unauthorizedResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
The request requires user authentication
unauthorized
false
description content
Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.
application/json
schema example
title type properties
forbiddenResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
The server understood the request, but refuses to authorize it
forbidden
false
description content
Not Found. The resource being accessed does not exist.
application/json
schema example
title type properties
notFoundResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
The requested resource could not be found
not_found
false
description content
Validation Error. The request includes one or more invalid params. Please check the request params and try again.
application/json
schema example
title type properties
unprocessableEntityResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
The request was well-formed but was unable to be followed due to semantic errors
unprocessable_entity
false
description content
Rate-limit exceeded
application/json
schema example
title type properties
rateLimitExceededResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
Too many requests, please try again later
rate_limit_exceeded
false
description content
Server Error. Something went wrong, try again later.
application/json
schema example
title type properties
internalServerErrorResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
The server encountered an internal error and was unable to complete your request
internal_server_error
false
description content
Bad Gateway
application/json
schema example
title type properties
badGatewayResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
The server was acting as a gateway or proxy and received an invalid response from the upstream server
bad_gateway
false
description content
Service Unavailable
application/json
schema example
title type properties
serviceUnavailableResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
The server is currently unable to handle the request due to a temporary overload or scheduled maintenance
service_unavailable
false
description content
Gateway Timeout
application/json
schema example
title type properties
gatewayTimeoutResponse
object
message type success
type
string
type enum
string
gateway_timeout
service_unavailable
bad_gateway
internal_server_error
unprocessable_entity
not_found
forbidden
unauthorized
invalid_request
invalid_token
insufficient_scope
service_error
invalid_path
rate_limit_exceeded
type
boolean
message type success
The server was acting as a gateway or proxy and did not receive a timely response from the upstream server
gateway_timeout
false
get
/chapter_recitations/{reciter_id}
url description
Pre-production Server
url description
Production Server
x-auth-token x-client-id
x-auth-token x-client-id
type description name in
apiKey
The access token required for accessing the endpoints.
x-auth-token
header
type description name in
apiKey
Your client Id
x-client-id
header
title description version
Content APIs
Quran.Foundation Content APIs offer programmatic access to the Quran's core content like chapters, verses, recitations, translations, and more, distinct from user-specific data like notes and bookmarks provided by [User-related APIs](/docs/category/user-related-apis). :::important Integrity of Translations Please **disable any automatic browser-translation features** (e.g. Google-Translate-in-Chrome) when displaying text returned by the *Translations* endpoints. Re-translating an already vetted Quranic translation can introduce serious semantic errors. ::: ## How to get access We are using OAuth2 flows to authenticate and authorize requests. To get started, you need to [get an access token](/docs/tutorials/oidc/getting-started-with-oauth2#obtaining-oauth-20-client-credentials) to make requests to our APIs. Since the APIs are not user-related, you will need to use the `client_credentials` grant type and [`content` scope](/docs/user_related_apis_versioned/scopes#content) when sending a request to [The OAuth 2.0 Token Endpoint](/docs/oauth2_apis_versioned/oauth-2-token-exchange) to get the access token. ```mermaid sequenceDiagram participant App as Your App participant Auth as Quran.Foundation<br/>Authorization Server participant API as Quran.Foundation<br/>Resources Server App->>Auth: Request Token with Client Credentials Auth-->>App: Token Response (access_token) App->>API: Use token to call API API-->>App: Requested resource Note over App,Auth: Access token expires (1 hour) App->>Auth: Re-issue access_token using client_credentials Auth-->>App: New access_token ``` After getting a valid access token, each request to get resources will have to include 2 headers mentioned below: `x-auth-token` and `x-client-id`. This spec also includes a small subset of Quran Reflect post-read endpoints that are compatible with the `client_credentials` grant. These operations still require `x-auth-token` and `x-client-id`, but they do not use the `content` scope. Use `post.read` for `/quran-reflect/v1/posts/feed`, `/quran-reflect/v1/posts/{id}`, and `/quran-reflect/v1/posts/user-posts/{id}`. Use `comment.read` for `/quran-reflect/v1/posts/{id}/comments` and `/quran-reflect/v1/posts/{id}/all-comments`. These are Quran Reflect gateway endpoints, not `/content/api/v4/...` endpoints.
v4
name description url header method
List of all chapter audio files of a reciter
content type
Get list of chapters' audio files of a reciter.
text/plain
path host query variable
chapter_recitations
:reciter_id
{{baseUrl}}
disabled description type value key
false
content type
(Required) Chapter-reciter ID from [/resources/chapter_reciters](/docs/content_apis_versioned/chapter-reciters). Do not use ayah-by-ayah recitation IDs from [/resources/recitations](/docs/content_apis_versioned/recitations) here.
text/plain
any
reciter_id
key value
Accept
application/json
GET
sidebar_class_name get api-method
info_path docs/content_apis_versioned/content-apis
custom_edit_url
displayed_sidebar APIsSidebar

import ApiTabs from "@theme/ApiTabs"; import MimeTabs from "@theme/MimeTabs"; import ParamsItem from "@theme/ParamsItem"; import ResponseSamples from "@theme/ResponseSamples"; import SchemaItem from "@theme/SchemaItem"; import SchemaTabs from "@theme/SchemaTabs"; import DiscriminatorTabs from "@theme/DiscriminatorTabs"; import TabItem from "@theme/TabItem";

List of all chapter audio files of a reciter

Get list of chapters' audio files of a reciter.

Path Parameters

    Successful response

    Schema
      audio_files object[] required
    • Array [
    • ]

    Will be returned when the request is invalid e.g. request is missing required headers or with invalid query parameters.

    Schema

      Will be returned when the request is unauthorized.

      Schema

        Forbidden error. Can either be due to access token not being passed, having been expired or the caller trying to access a resource without enough permissions.

        Schema

          Not Found. The resource being accessed does not exist.

          Schema

            Validation Error. The request includes one or more invalid params. Please check the request params and try again.

            Schema

              Rate-limit exceeded

              Schema

                Server Error. Something went wrong, try again later.

                Schema

                  Bad Gateway

                  Schema

                    Service Unavailable

                    Schema

                      Gateway Timeout

                      Schema