GET ​/api​/v3​/audio​/:authorization_key

Redirects to a final audio file.

Request

Example Request

{
  "hq": {
  },
  "lat": 29.7628,
  "lng": -95.3831,
  "city": "Houston",
  "province": "TX",
  "country": "USA"
}

Example Parameters

  • hq: Whether or not to retrieve a higher quality audio file. This should be true if the user is on Wi-Fi and false if on a cellular network.

    • Required: no
    • Type: bool
    • Example: true
  • lat: The user's latitude (if available).

    • Required: no
    • Type: number
    • Example: 29.7628
  • lng: The user's longitude (if available).

    • Required: no
    • Type: number
    • Example: -95.3831
  • city: The user's city. This should be retrieved by reverse geo-coding the user's lat/lng in order to alleviate centralized reverse geocoding.

    • Required: no
    • Type: string
    • Example: Houston
  • province: The user's state or province. This should be retrieved by reverse geo-coding the user's lat/lng in order to alleviate centralized reverse geocoding.

    • Required: no
    • Type: string
    • Example: TX
  • country: The user's country. This should be retrieved by reverse geo-coding the user's lat/lng in order to alleviate centralized reverse geocoding.

    • Required: no
    • Type: string
    • Example: USA

Response

Example Response

{
}

Response Parameters

Response Codes

Successful Response Codes

  • 302: A redirect response where the audio file can be retrieved. This URL is temporary and must be discarded after use.

Failure Response Codes

  • 403: Access to this audio file is forbidden. Likely the authorization token provided is invalid or has expired.