Get list of Audio files of single recitation

Get list of #model:knzdXGgyjYnAqbhGX for a single recitation. See #endpoint:HLbauN2sdGitPQPPL endpoint to fetch available recitations.

You can also include more fields of audio files using fields query string.

Path Parameters

recitation_id number required

Recitation id

Query Parameters

fields string

comma seperated field of audio files.

chapter_number integer

Possible values: >= 1 and <= 114

If you want to get audio file of a specific surah.

juz_number integer

Possible values: >= 1 and <= 30

If you want to get audio file of a specific juz.

page_number integer

Possible values: >= 1 and <= 604

If you want to get audio file of a Madani Muhsaf page

hizb_number integer

Possible values: >= 1 and <= 60

If you want to get audio file of a specific hizb.

rub_el_hizb_number integer

Possible values: >= 1 and <= 240

If you want to get audio file of a specific Rub el Hizb.

verse_key string

If you want to get audio file of a specific ayah.

Responses

• 200
• 400
• 401
• 403
• 404
• 422
• 429
• 500
• 502
• 503
• 504

---

Successful response

application/json

Schema

Example (from schema)

Example

---

Schema

audio_files object[] required
Array [
url string
duration number
format string
segments object[]
]
meta object
reciter_name string

{
  "audio_files": [
    {
      "url": "https://verses.quran.foundation/AbdulBaset/Mujawwad/mp3/001001.mp3",
      "duration": 6,
      "format": "mp3",
      "segments": [
        [
          [
            0,
            120,
            -1
          ],
          [
            120,
            420,
            0
          ],
          [
            540,
            810,
            1
          ],
          [
            1350,
            1006,
            2
          ],
          [
            2356,
            2454,
            3
          ],
          [
            4810,
            390,
            -1
          ]
        ]
      ]
    }
  ],
  "meta": {
    "reciter_name": "string"
  }
}

{
  "audio_files": [
    {
      "verse_key": "1:1",
      "url": "Alafasy/mp3/001001.mp3"
    },
    {
      "verse_key": "1:2",
      "url": "Alafasy/mp3/001002.mp3"
    },
    {
      "verse_key": "1:3",
      "url": "Alafasy/mp3/001003.mp3"
    },
    {
      "verse_key": "1:4",
      "url": "Alafasy/mp3/001004.mp3"
    },
    {
      "verse_key": "1:5",
      "url": "Alafasy/mp3/001005.mp3"
    },
    {
      "verse_key": "1:6",
      "url": "Alafasy/mp3/001006.mp3"
    },
    {
      "verse_key": "1:7",
      "url": "Alafasy/mp3/001007.mp3"
    }
  ],
  "meta": {
    "reciter_name": "Mishari Rashid al-`Afasy",
    "recitation_style": null
  }
}

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

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "The request is missing required headers or is invalid",
  "type": "invalid_request",
  "success": false
}

Will be returned when the request is unauthorized.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "The request requires user authentication",
  "type": "unauthorized",
  "success": false
}

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 (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "The server understood the request, but refuses to authorize it",
  "type": "forbidden",
  "success": false
}

Not Found. The resource being accessed does not exist.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "The requested resource could not be found",
  "type": "not_found",
  "success": false
}

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

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "The request was well-formed but was unable to be followed due to semantic errors",
  "type": "unprocessable_entity",
  "success": false
}

Rate-limit exceeded

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "Too many requests, please try again later",
  "type": "rate_limit_exceeded",
  "success": false
}

Server Error. Something went wrong, try again later.

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "The server encountered an internal error and was unable to complete your request",
  "type": "internal_server_error",
  "success": false
}

Bad Gateway

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "The server was acting as a gateway or proxy and received an invalid response from the upstream server",
  "type": "bad_gateway",
  "success": false
}

Service Unavailable

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "The server is currently unable to handle the request due to a temporary overload or scheduled maintenance",
  "type": "service_unavailable",
  "success": false
}

Gateway Timeout

application/json

Schema

Example (from schema)

Example

---

Schema

message string
type string

Possible values: [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]

success boolean

{
  "message": "string",
  "type": "gateway_timeout",
  "success": true
}

{
  "message": "The server was acting as a gateway or proxy and did not receive a timely response from the upstream server",
  "type": "gateway_timeout",
  "success": false
}

Loading...