API & DOCS

My Account            

Use the Download Recordings API to Manage Call Recordings

128128

The Download Recordings API may be used to manage call recordings from any application. This API also allows the user to uploaded recordings for use in appropriate applications (list apps).

The user may utilize the Download Recordings option with the Download, List, Remove, and Upload methods.

Download

recording.download

Use the Download method to download a call recording.

The parameters listed in the following table may be needed to complete this action:

ParameterRequiredAcceptsNotes
access_keyYesStringA Valid Access Key for your account
secret_access_keyYesStringA Valid Secret Key for your account
formatNoStringAllowed formats are .mp3 or .wav and defaults to .wav if no format is provided
sample_rateNoIntegerDefaults to 8000 if not sample_rate is provided
sidYesStringA Valid Call SID for your account

Example URL

/ibp_api.php?access_key=foofoofoo&secret_access_key=foobarfoo&action=recording.download&format=mp3&sample_rate=44100&sid=0907065723240097

API Responses

200 OK

Returns the binary audio stream for SID as an array of bytes in the specified audio format (MIME type).

202 Accepted

<response>
<result>failed</result>
<result_description>The requested recording is currently being processed by the system. Please check back later.</result_description>
</response>

400 Bad Request

<response>
<result>failed</result>
<result_description>Parameter sid is required</result_description>
</response>

401 Unauthorized

<response>
<result>failed</result>
<result_description>Invalid api_key</result_description>
</response>

404 Not Found

<response>
<result>failed</result>
<result_description>File not found</result_description>
</response>

404 Not Found

<response>
<result>failed</result>
<result_description>Error in retrieving recording</result_description>
</response>

List

recording.list

Use the List method to list recordings.

The parameters listed in the following table may be needed to complete this action:

ParameterRequiredAcceptsNotes
access_keyYesStringA Valid Access Key for your account
secret_access_keyYesStringA Valid Secret Key for your account
typeYesStringAllowed Types: findme, locator, recorded_calls, survey, queue, powerdialer, recorded_call, user_recordings
idYesIntegerA Valid ID of the provided Type

Example URL

/ibp_api.php?access_key=foofoofoo&secret_access_key=foobarfoo&action=recording.list&type=findme&id=1234

API Response

200 OK

<response>
<result>success</result>
<result_description></result_description>
<data>
<recording>
<sid>0932654521723728</sid>
<dnis>8475551234</dnis>
<number_connected>3125551265</number_connected>
<minutes>5.3</minutes>
<date>2019-02-20 20:42:11</date>
</recording>
<recording>
<sid>123456789101112</sid>
<dnis>8475551234</dnis>
<number_connected>3125551265</number_connected>
<minutes>12.1</minutes>
<date>2019-01-20 07:09:55</date>
</recording>
</data>
</response>

400 Bad Request

<response>
<result>failed</result>
<result_description>Parameter type is required</result_description>
</response>

400 Bad Request

<response>
<result>failed</result>
<result_description>Parameter id is required</result_description>
</response>

404 Not Found

<response>
<result>failed</result>
<result_description>No results returned</result_description>
</response>

Remove

recording.remove

Use the Remove method to remove an audio file for a recorded call.

The parameters listed in the following table may be needed to complete this action:

ParameterRequiredAcceptsNotes
access_keyYesStringA Valid Access Key for your account
secret_access_keyYesStringA Valid Secret Key for your account
delete_nowNoBooleanAccepted values are 1 for removing the recording now and 0 for removing the recording later
sidYesStringA valid SID from your account

Example URL

/ibp_api.php?access_key=foofoofoo&secret_access_key=foobarfoo&action=recording.remove&delete_now=1&sid=0907065723240097

API Responses

200 OK

<response>
<result>success</result>
<result_description>Recording successfully removed</result_description>
</response>

202 Accepted

<response>
<result>failed</result>
<result_description>The requested recording is currently being processed by the system. Please check back later.</result_description>
</response>

400 Bad Request

<response>
<result>failed</result>
<result_description>Parameter sid is required</result_description>
</response>

404 Not Found

<response>
<result>failed</result>
<result_description>Error in removing recording</result_description>
</response>

404 Not Found

<response>
<result>failed</result>
<result_description>File not found</result_description>
</response>

Upload

recording.upload

Use the Upload method to upload an audio file for use with various building blocks.

The parameters listed in the following table may be needed to complete this action:

ParameterRequiredAcceptsNotes
access_keyYesStringA Valid Access Key for your account
secret_access_keyYesStringA Valid Secret Key for your account
idYesIntegerA Valid ID of the provided Type
pathYesStringPath to audio file
typeYesStringAllowed Types: findme, locator, recorded_calls, survey, queue, powerdialer, recorded_call, user_recordings

Example URL

/ibp_api.php?access_key=foofoofoo&secret_access_key=foobarfoo&action=recording.upload&type=findme&path=/path/to/audio.wav&id=1234

API Responses

200 OK

<response>
<result>success</result>
<result_description>File uploaded</result_description>
</response>

API Test Panel

4848

Use the DialogTech API Wizard and Test Panel to make changes to a customer account.

Please note that this tool works with the live data in a customer account. The user must be careful when adding, editing, or deleting data.