{"_id":"55917c224e50b50d001960e7","version":{"_id":"558d9c33beb7c719007f631c","project":"558d9c32beb7c719007f6319","__v":19,"createdAt":"2015-06-26T18:38:43.154Z","releaseDate":"2015-06-26T18:38:43.153Z","categories":["558d9c33beb7c719007f631d","558db0bc7afc102f008ed863","558db0d07afc102f008ed864","558db3c84cd25f0d00b7ecb2","558dbace7afc102f008ed894","558dbd104cd25f0d00b7ecca","558dbd4c4cd25f0d00b7eccb","559d3e858639bd21008e90a6","55bb8ca5a8400c2d00873e70","58fdfb438fbd2819000db9eb","590829c7ade4172d006a87b8","59082a11beedcf0f00235d87","5908bd2cba2afd23007d6d12","5908d1f64f544425002b6aae","591e5e9e2c1b1f0f000fa4e5","5a283434aba91f002834ea86","5a69fe5cde745d002c936c66","5a81e6ef761cf300127317f8","5a81e7d63b1e120012bed5a1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"category":{"_id":"5908d1f64f544425002b6aae","project":"558d9c32beb7c719007f6319","__v":0,"version":"558d9c33beb7c719007f631c","sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-05-02T18:37:42.174Z","from_sync":false,"order":9,"slug":"legacy-documentation","title":"Legacy Documentation"},"project":"558d9c32beb7c719007f6319","parentDoc":null,"user":"558d70614cd25f0d00b7eba4","__v":75,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-29T17:10:58.869Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":12,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Use the Download Recordings API to manage call recordings.\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/0EBfKqGGT7eExlRlrjZL_1437078978_download-512x512px.png\",\n        \"1437078978_download-512x512px.png\",\n        \"128\",\n        \"128\",\n        \"#23b65a\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nThe 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).\n\nThe user may utilize the Download Recordings option with the Download, List, Remove, and Upload methods.\n\n## Download\n    recording.download\n\nUse the Download method to download a call recording.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Format\",\n    \"1-1\": \"X\",\n    \"3-0\": \"SID\",\n    \"3-1\": \"X\",\n    \"2-0\": \"Sample Rate\",\n    \"2-2\": \"X\",\n    \"4-0\": \"Type\",\n    \"4-2\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 5\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example URLs\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/dc6eOr0eT4gPGj8x55LW_1440199635_link_add.png\",\n        \"1440199635_link_add.png\",\n        \"32\",\n        \"32\",\n        \"#609e04\",\n        \"\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Download Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=recording.download&type=findme&format=mp3&sample_rate=44100&sid=0907065723240097\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**List Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=recording.list&type=findme&id=1234\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Remove Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?api_key=foofoofoo&action=recording.remove&sid=012345&delete_now=1\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Upload Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example Responses\",\n  \"sidebar\": true\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/XfuyxtySaCcUQ3IPtKXA_1440199713_XML_Extention.png\",\n        \"1440199713_XML_Extention.png\",\n        \"32\",\n        \"32\",\n        \"#37472b\",\n        \"\"\n      ]\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Download Example URL:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"File Download Complete\",\n      \"language\": \"text\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**List Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description></result_description>\\n<data>\\n<recording>\\n<sid>0932654521723728</sid>\\n<dnis>8475551234</dnis>\\n<number_connected>3125551265</number_connected>\\n<minutes>5.3</minutes>\\n<date>2009-08-21 11:03:46</date>\\n</recording>\\n</data>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Remove Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>Recording successfully removed</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n\n[block:textarea]\n{\n  \"text\": \"**Upload Example Response:** \",\n  \"sidebar\": true\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n    \n## List\n    recording.list\n\nUse the List method to list recordings.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Type\",\n    \"1-1\": \"X\",\n    \"2-0\": \"ID\",\n    \"2-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n    \n## Remove\n    recording.remove\n\nUse the Remove method to remove an audio file for a recorded call.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"Delete Now\",\n    \"1-2\": \"X\",\n    \"2-0\": \"SID\",\n    \"2-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n**API Test Panel** \n\n    \n## Upload\n    recording.upload\n\nUse the Upload method to upload an audio file for use with various building blocks.\n\nThe parameters listed in the following table may be needed to complete this action:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"PARAMETER\",\n    \"h-1\": \"REQUIRED\",\n    \"h-2\": \"OPTIONAL\",\n    \"0-0\": \"API Key\",\n    \"0-1\": \"X\",\n    \"1-0\": \"ID\",\n    \"1-1\": \"X\",\n    \"2-0\": \"Path\",\n    \"2-1\": \"X\",\n    \"3-0\": \"Type\",\n    \"3-1\": \"X\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"link\",\n  \"title\": \"API Test Panel\"\n}\n[/block]\n\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/hLdoCEu3SridcvynAPdw_1437618071_monitor-gear-control-panel.png\",\n        \"1437618071_monitor-gear-control-panel.png\",\n        \"48\",\n        \"48\",\n        \"#fcf1d4\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]\nUse the DialogTech [API Wizard and Test Panel](https://secure.ifbyphone.com/developer_testpanel.php) to make changes to a customer account.\n\nPlease note that this tool works with the live data in a customer account. The user must be careful when adding, editing, or deleting data.","excerpt":"","slug":"download-recordings","type":"basic","title":"DOWNLOAD RECORDINGS"}

DOWNLOAD RECORDINGS


Use the Download Recordings API to manage call recordings.

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:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

Format

X

Sample Rate

X

SID

X

Type

X

Example URLs

Download Example URL:

/ibp_api.php?api_key=foofoofoo&action=recording.download&type=findme&format=mp3&sample_rate=44100&sid=0907065723240097

List Example URL:

/ibp_api.php?api_key=foofoofoo&action=recording.list&type=findme&id=1234

Remove Example URL:

/ibp_api.php?api_key=foofoofoo&action=recording.remove&sid=012345&delete_now=1

Upload Example URL:

Example Responses

Download Example URL:

File Download Complete

List Example Response:

<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>2009-08-21 11:03:46</date>
</recording>
</data>
</response>

Remove Example Response:

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

Upload Example 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:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

Type

X

ID

X

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:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

Delete Now

X

SID

X

API Test Panel

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:

PARAMETER
REQUIRED
OPTIONAL

API Key

X

ID

X

Path

X

Type

X

linkAPI Test Panel

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.