{"_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","githubsync":"","parentDoc":null,"user":"558d70614cd25f0d00b7eba4","__v":75,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-06-29T17:10:58.869Z","link_external":false,"link_url":"","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\": \"Accepts\",\n    \"0-0\": \"access_key\",\n    \"0-1\": \"Yes\",\n    \"2-0\": \"format\",\n    \"2-1\": \"No\",\n    \"4-0\": \"sid\",\n    \"4-1\": \"Yes\",\n    \"3-0\": \"sample_rate\",\n    \"3-2\": \"Integer\",\n    \"1-0\": \"secret_access_key\",\n    \"1-1\": \"Yes\",\n    \"2-2\": \"String\",\n    \"3-1\": \"No\",\n    \"h-3\": \"Notes\",\n    \"h-4\": \"Usage\",\n    \"0-2\": \"String\",\n    \"1-2\": \"String\",\n    \"4-2\": \"String\",\n    \"0-3\": \"A Valid Access Key for your account\",\n    \"2-3\": \"Allowed formats are .mp3 or .wav and defaults to .wav if no format is provided\",\n    \"3-3\": \"Defaults to 8000 if not sample_rate is provided\",\n    \"1-3\": \"A Valid Secret Key for your account\",\n    \"4-3\": \"A Valid Call SID for your account\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]\n## Example URL\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?access_key=foofoofoo&secret_access_key=foobarfoo&action=recording.download&format=mp3&sample_rate=44100&sid=0907065723240097\",\n      \"language\": \"http\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]\n## API Responses\n200 OK\n\nReturns the binary audio stream for SID as an array of bytes in the specified audio format (MIME type).\n\n202 Accepted\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>The requested recording is currently being processed by the system. Please check back later.</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n400 Bad Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>Parameter sid is required</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n401 Unauthorized\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>Invalid api_key</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n404 Not Found\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>File not found</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n404 Not Found\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>Error in retrieving recording</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\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\": \"Accepts\",\n    \"0-0\": \"access_key\",\n    \"0-1\": \"Yes\",\n    \"1-0\": \"secret_access_key\",\n    \"1-1\": \"Yes\",\n    \"2-0\": \"type\",\n    \"2-1\": \"Yes\",\n    \"h-3\": \"Notes\",\n    \"3-0\": \"id\",\n    \"3-1\": \"Yes\",\n    \"0-2\": \"String\",\n    \"1-2\": \"String\",\n    \"2-2\": \"String\",\n    \"3-2\": \"Integer\",\n    \"0-3\": \"A Valid Access Key for your account\",\n    \"1-3\": \"A Valid Secret Key for your account\",\n    \"3-3\": \"A Valid ID of the provided Type\",\n    \"2-3\": \"Allowed Types: findme, locator, recorded_calls, survey, queue, powerdialer, recorded_call, user_recordings\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n## Example URL\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?access_key=foofoofoo&secret_access_key=foobarfoo&action=recording.list&type=findme&id=1234\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n## API Response\n200 OK\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>2019-02-20 20:42:11</date>\\n</recording>\\n<recording>\\n<sid>123456789101112</sid>\\n<dnis>8475551234</dnis>\\n<number_connected>3125551265</number_connected>\\n<minutes>12.1</minutes>\\n<date>2019-01-20 07:09:55</date>\\n</recording>\\n</data>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n400 Bad Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>Parameter type is required</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n400 Bad Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>Parameter id is required</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n404 Not Found\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>No results returned</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\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\": \"Accepts\",\n    \"0-0\": \"access_key\",\n    \"0-1\": \"Yes\",\n    \"1-0\": \"secret_access_key\",\n    \"1-2\": \"String\",\n    \"2-0\": \"delete_now\",\n    \"2-1\": \"No\",\n    \"h-3\": \"Notes\",\n    \"3-0\": \"sid\",\n    \"1-1\": \"Yes\",\n    \"3-1\": \"Yes\",\n    \"0-3\": \"A Valid Access Key for your account\",\n    \"1-3\": \"A Valid Secret Key for your account\",\n    \"3-3\": \"A valid SID from your account\",\n    \"0-2\": \"String\",\n    \"3-2\": \"String\",\n    \"2-2\": \"Boolean\",\n    \"2-3\": \"Accepted values are 1 for removing the recording now and 0 for removing the recording later\"\n  },\n  \"cols\": 4,\n  \"rows\": 4\n}\n[/block]\n## Example URL\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?access_key=foofoofoo&secret_access_key=foobarfoo&action=recording.remove&delete_now=1&sid=0907065723240097\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n## API Responses\n200 OK\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}\n[/block]\n202 Accepted\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>The requested recording is currently being processed by the system. Please check back later.</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n400 Bad Request\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>Parameter sid is required</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n404 Not Found\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>Error in removing recording</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n404 Not Found\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>failed</result>\\n<result_description>File not found</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\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\": \"Accepts\",\n    \"0-0\": \"access_key\",\n    \"0-1\": \"Yes\",\n    \"1-0\": \"secret_access_key\",\n    \"1-1\": \"Yes\",\n    \"2-0\": \"id\",\n    \"2-1\": \"Yes\",\n    \"3-0\": \"path\",\n    \"3-1\": \"Yes\",\n    \"h-3\": \"Notes\",\n    \"4-0\": \"type\",\n    \"4-1\": \"Yes\",\n    \"4-2\": \"String\",\n    \"3-2\": \"String\",\n    \"2-2\": \"Integer\",\n    \"0-2\": \"String\",\n    \"1-2\": \"String\",\n    \"0-3\": \"A Valid Access Key for your account\",\n    \"1-3\": \"A Valid Secret Key for your account\",\n    \"4-3\": \"Allowed Types: findme, locator, recorded_calls, survey, queue, powerdialer, recorded_call, user_recordings\",\n    \"3-3\": \"Path to audio file\",\n    \"2-3\": \"A Valid ID of the provided Type\"\n  },\n  \"cols\": 4,\n  \"rows\": 5\n}\n[/block]\n## Example URL\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"/ibp_api.php?access_key=foofoofoo&secret_access_key=foobarfoo&action=recording.upload&type=findme&path=/path/to/audio.wav&id=1234\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n## API Responses\n200 OK\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description>File uploaded</result_description>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ]\n}\n[/block]\n\n[block:api-header]\n{\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.dialogtech.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"}