Play or download audio
This endpoint streams or download audio for either a voicemail, recording, call recording or music on hold. The audio stream remains available for 3 hours.
Path Parameters
type string required
Possible values: [voicemail
, recording
, call-recording
, music
]
The type of audio to retrieve
id string required
The ID of the voicemail, recording, call recording or music on hold to retrieve
Query Parameters
token string required
The token to authenticate the request
download boolean
Whether to download the audio instead of streaming it
Header Parameters
range string
The range of the audio to retrieve (automatically set by the player)
Responses
- 206
- 400
- 401
- 404
- 500
Buffered audio stream
audio/mpeg
Schema
Schema
string
Invalid request body
application/json
Schema
Example (from schema)
Schema
- Array [
- ]
errors object[]
code string
Human readable error code
message string
Human readable error message
detail string
Human readable error detail
{
"errors": [
{
"code": "ERROR_CODE",
"message": "An error occurred while calling the endpoint",
"detail": "View more info at developers.rinkel.com"
}
]
}
Unauthorized
The audio was not found
Internal Server Error
Loading...