This rest api will allow you to list and get recordings from CallFire.
- Jump to Method
- Get List of Recordings for a Call
- Get a Single Recording
- Get a Dynamic Recording
- Get a Dynamic Recording as MP3
Get List of Recordings for a Call
URL
https://www.callfire.com/cloud/1/files/recording/list/{campid}/{callid}?apikey={apikey}
HTTP Method
GET
Content Type
text/plain
Parameters
| Parameter name | Required | Description |
|---|---|---|
| apikey | Y | The API key that is registered with your account |
Example Response
The response content type can be xml or json.
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
Recordings Fetched
true
XXXXX
XXXXXX
https://www.callfire.com/cloud/1/files/recording/XXX
https://www.callfire.com/cloud/1/files/recording/XXXX
Get a Single Recording
URL
https://www.callfire.com/cloud/1/files/recording/{fileid}
HTTP Method
GET
Content Type
text/plain
Parameters
| Parameter name | Required | Description |
|---|---|---|
| fileid | Y | Path parameter that identifies the recording id |
| apikey | Y | Query parameter for your account api key. |
Response
audio/x-wav
Get a Dynamic Recording
This HTTP request allows the client to download .wav files that were dynamically generated during phone calls.
URL
https://www.callfire.com/cloud/1/files/recording/dynamic/{hash}/{year}/{month}/{campaign}/{filename}?apikey={apikey}
HTTP Method
GET
Content Type
text/plain
Parameters
| Parameter name | Required | Description |
|---|---|---|
| hash | Y | The hash code of the sound file |
| year | Y | The year the sound file was generated |
| month | Y | The month the sound file was generated |
| campaign | Y | The unique identifier of the campaign under which the sound file was generated |
| filename | Y | The name of the remote sound file(note that this is not the name of any local file on the client's machine) |
| apikey | Y | The API key that is registered with your account |
Response
audio/x-wav
Get a Dynamic Recording as MP3
This HTTP request is essentially the same as "Get a Dynamic Recording" described above except that it returns a file in MP3 format.
URL
https://www.callfire.com/cloud/1/files/recording/dynamic/{hash}/{year}/{month}/{campaign}/{filename}/mp3?apikey={apikey}
HTTP Method
GET
Content Type
text/plain
Parameters
| Parameter name | Required | Description |
|---|---|---|
| hash | Y | The hash code of the sound file |
| year | Y | The year the sound file was generated |
| month | Y | The month the sound file was generated |
| campaign | Y | The unique identifier of the campaign under which the sound file was generated |
| filename | Y | The name of the remote sound file(note that this is not the name of any local file on the client's machine) |
| apikey | Y | The API key that is registered with your account |
Response
audio/mp3