Recordings and Files Rest API

How it Works

This rest api will allow you to list and get recordings from CallFire.

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

• apikey: Required. This is your account api key.

Response

application/xml or application/json

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<fileResponse>
    <description>Recordings Fetched</description>
    <successful>true</successful>
    <callid>XXXXX</callid>
    <campaignid>XXXXXX</campaignid>
    <recording>https://www.callfire.com/cloud/1/files/recording/XXX</recording>
    <recording>https://www.callfire.com/cloud/1/files/recording/XXXX</recording>
</fileResponse>

Get a single recording

URL

https://www.callfire.com/cloud/1/files/recording/{fileid}

HTTP Method

GET

Content Type

text/plain

Parameters

• fileid: Required. Path parameter that identifies the recording id
• apikey: Required. 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

• hash: The hash code of the sound file.
• year: The year the sound file was generated.
• month: The month the sound file was generated.
• campaign: The unique identifier of the campaign under which the sound file was generated.
• filename: The name of the remote sound file(note that this is not the name of any local file on the client's machine).
• apikey: The user's account API key.

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

• hash: The hash code of the sound file.
• year: The year the sound file was generated.
• month: The month the sound file was generated.
• campaign: The unique identifier of the campaign under which the sound file was generated.
• filename: The name of the remote sound file(note that this is not the name of any local file on the client's machine).
• apikey: The user's account API key.

Response

audio/mp3