{"_id":"5ccca26e4fb83e004a13bb35","project":"558d9c32beb7c719007f6319","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"},"user":"5c017094c280da030b53c114","__v":0,"parentDoc":null,"metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2019-05-03T20:19:58.138Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":9,"body":"[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Used to download a voicemail box recording by an individual session ID\"\n}\n[/block]\nUse the Get Message By SID API to download specific messages that callers have left you in your DialogTech voicemail box.\n\nBase URL for Register Number\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://secure.dialogtech.com/ibp_api.php\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\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    \"1-0\": \"access_key\",\n    \"1-1\": \"Yes\",\n    \"3-0\": \"vmail_sid\",\n    \"3-1\": \"Yes\",\n    \"2-0\": \"secret_access_key\",\n    \"2-1\": \"Yes\",\n    \"3-2\": \"String\",\n    \"h-3\": \"Notes\",\n    \"h-4\": \"Usage\",\n    \"1-2\": \"String\",\n    \"2-2\": \"String\",\n    \"1-3\": \"A Valid Access Key for your account\",\n    \"3-3\": \"ID of the phone call.\",\n    \"2-3\": \"A Valid Secret Key for your account\",\n    \"0-0\": \"action\",\n    \"0-1\": \"Yes\",\n    \"0-2\": \"vmail.getmessagebysid\",\n    \"0-3\": \"Only accepts getmessagebysid to download a voicemail recording.\",\n    \"0-4\": \"Defines the API Call as \\\"Get Message By SID\\\" type\",\n    \"1-4\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"2-4\": \"Credentials used for access to the API for a particular DialogTech account\",\n    \"3-4\": \"Defines which call the desired voicemail recording is associated with.\"\n  },\n  \"cols\": 5,\n  \"rows\": 4\n}\n[/block]\n\n[block:api-header]\n{\n  \"title\": \"Using this API\"\n}\n[/block]\n## Example URL\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"https://secure.dialogtech.com/ibp_api.php?action=vmail.getmessagebysid&access_key=XYZ&secret_access_key=XYZ&vmail_sid=1904294c8ef3ddee\",\n      \"language\": \"http\"\n    }\n  ]\n}\n[/block]\n## Example Response\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"<response>\\n<result>success</result>\\n<result_description></result_description>\\n<data>\\n<message>\\n<url>https://www.domain.com/user_recordings/10/10778/vmail/3201/20120304184259_8475301134.wav</url>\\n<envelope>20120304184259_8475301134.wav</envelope>\\n<sid>1202017652466437</sid>\\n<duration>0</duration>\\n<date>2012-03-04 18:42:59</date>\\n</message>\\n</data>\\n</response>\",\n      \"language\": \"xml\"\n    }\n  ],\n  \"sidebar\": true\n}\n[/block]","excerpt":"Used to download a voicemail box recording by an individual session ID","slug":"download-voicemails-1","type":"basic","title":"DOWNLOAD VOICEMAILS"}

DOWNLOAD VOICEMAILS

Used to download a voicemail box recording by an individual session ID

Used to download a voicemail box recording by an individual session ID

Use the Get Message By SID API to download specific messages that callers have left you in your DialogTech voicemail box.

Base URL for Register Number

https://secure.dialogtech.com/ibp_api.php

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

Parameter
Required
Accepts
Notes
Usage

action

Yes

vmail.getmessagebysid

Only accepts getmessagebysid to download a voicemail recording.

Defines the API Call as "Get Message By SID" type

access_key

Yes

String

A Valid Access Key for your account

Credentials used for access to the API for a particular DialogTech account

secret_access_key

Yes

String

A Valid Secret Key for your account

Credentials used for access to the API for a particular DialogTech account

vmail_sid

Yes

String

ID of the phone call.

Defines which call the desired voicemail recording is associated with.

Using this API

Example URL

https://secure.dialogtech.com/ibp_api.php?action=vmail.getmessagebysid&access_key=XYZ&secret_access_key=XYZ&vmail_sid=1904294c8ef3ddee

Example Response

<response>
<result>success</result>
<result_description></result_description>
<data>
<message>
<url>https://www.domain.com/user_recordings/10/10778/vmail/3201/20120304184259_8475301134.wav</url>
<envelope>20120304184259_8475301134.wav</envelope>
<sid>1202017652466437</sid>
<duration>0</duration>
<date>2012-03-04 18:42:59</date>
</message>
</data>
</response>