{"_id":"594bf9e801cfe6000f40f4c9","project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":21,"project":"55c8cff571d7580d0063a5e5","createdAt":"2016-06-16T06:12:38.244Z","releaseDate":"2016-06-16T06:12:38.244Z","categories":["57624356653c2d2200fec79d","57624356653c2d2200fec79e","57624356653c2d2200fec79f","57624356653c2d2200fec7a0","57624356653c2d2200fec7a1","57624356653c2d2200fec7a2","57624356653c2d2200fec7a3","57624356653c2d2200fec7a4","57624356653c2d2200fec7a5","57624356653c2d2200fec7a6","57624356653c2d2200fec7a7","57624356653c2d2200fec7a8","57624356653c2d2200fec7a9","57624356653c2d2200fec7aa","5779ca1b99b40b0e005abb3a","5779d198aea88b0e00f63277","5797d3ab17ced017003c4be4","57ac170ef1cdae0e0053cdfc","57dbfc723ed3450e00dc9e6d","5804d12d16161c0f0077df9b","5841064b652e5b0f0015a7c8","588b5e5f2966b2230009cbf9","58a68ebf3239fa0f00857619","58c23c8b4922930f0050ac91","58fd1460809fc30f00f2ee07","5934eaf5328680002d77de6a","594bf91601cfe6000f40f4c5","595c4ed696b447001ba0cf6d","596524495cee50001575f5be","5970d4f1313162004dd303b5","59780fac24dbd1001a1fa057","59a8cfd3ead78a002d63cafe","59e0323d93da1f001c9ec170","5b0c16f2be9fcb0003e28222"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"594bf91601cfe6000f40f4c5","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-06-22T17:06:30.127Z","from_sync":false,"order":30,"slug":"account-voicemail","title":"Account Voicemail"},"user":"56f99ab84d2b4f3400edb636","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-06-22T17:10:00.666Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"results":{"codes":[]},"settings":"","auth":"required","params":[],"url":""},"isReference":false,"order":0,"body":"[block:callout]\n{\n  \"type\": \"info\",\n  \"body\": \"Note: This API is for users with Account Owner scope access token.  Users with Extension User scope token should invoke the Voicemail API with the following definition:\\n\\nhttps://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/voicemail\"\n}\n[/block]\n## Supported Services\n* [List Voicemail](doc:list-account-voicemail) \n* [Get Voicemail](doc:get-account-voicemail) \n* [Patch Voicemail](doc:patch-account-voicemail) \n\n## Summary Object\nThe Voicemail Summary Object is used to briefly represent a voicemail. It can be seen in several places throughout this API. Here are the properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-0\": \"`id`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Unique Voicemail ID. Read-only.\",\n    \"1-0\": \"`download_url`\",\n    \"1-1\": \"String\",\n    \"1-2\": \"URL which may be used by the API user for voicemail download\",\n    \"2-0\": \"`extension`\",\n    \"2-1\": \"[Extension Summary Object](doc:account-extensions#section-summary-object)\",\n    \"3-0\": \"`from`\",\n    \"3-1\": \"[From Object](#section-from-object)\",\n    \"2-2\": \"Extension where the voicemail is saved into.\",\n    \"3-2\": \"The caller's information\",\n    \"4-0\": \"`to`\",\n    \"4-1\": \"String\",\n    \"4-2\": \"The phone number where the caller is calling\",\n    \"5-0\": \"`is_new`\",\n    \"5-1\": \"Boolean\",\n    \"5-2\": \"True when Voicemail is new; False when Voicemail has been listened\",\n    \"6-0\": \"`created_at`\",\n    \"6-1\": \"String\",\n    \"6-2\": \"Date string representing the UTC time that the object was created in the Phone.com API system.\",\n    \"7-0\": \"'folder'\",\n    \"7-1\": \"String\",\n    \"7-2\": \"Folder name where voicemail is saved\",\n    \"8-0\": \"'duration'\",\n    \"8-1\": \"Integer\",\n    \"8-2\": \"Length of voicemail in seconds\"\n  },\n  \"cols\": 3,\n  \"rows\": 9\n}\n[/block]\nHere's an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"ef8e574535c7bdfba131504a57026fda90c33370\\\",\\n    \\\"download_url\\\": \\\"https://api.phone.com/v4/accounts/337171/voicemail/ef8e574535c7bdfba131504a57026fda90c33370/download\\\",\\n    \\\"extension\\\": {\\n        \\\"id\\\": 709038,\\n        \\\"name\\\": \\\"Home 1\\\",\\n        \\\"extension\\\": 18,\\n        \\\"voip_id\\\": 337171,\\n    },\\n    \\\"from\\\": {\\n        \\\"number\\\": \\\"Unknown\\\",\\n        \\\"name\\\": \\\"V6211235150015316714\\\",\\n        \\\"city\\\": null,\\n        \\\"state\\\": null\\n    },\\n    \\\"to\\\": \\\"+17326830492\\\",\\n    \\\"is_new\\\": false,\\n    \\\"created_at\\\": 1498066543,\\n    \\\"folder\\\": \\\"INBOX\\\",\\n    \\\"duration\\\": 3,\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Voicemail Object includes all of the properties in the [Voicemail Summary Object](#section-summary-object).\n\n## From Object\nEach entry in a Voicemail's from list is an object with the following properties:\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Description\",\n    \"0-0\": \"`number`\",\n    \"0-1\": \"The caller phone number\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"The name / caller ID of the caller\",\n    \"2-0\": \"`city`\",\n    \"2-1\": \"The city where the caller is from\",\n    \"3-0\": \"`state`\",\n    \"3-1\": \"The state where the caller is from\"\n  },\n  \"cols\": 2,\n  \"rows\": 4\n}\n[/block]\nHere's an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"number\\\": \\\"+17867093862\\\",\\n    \\\"name\\\": \\\"MIAMI        FL\\\",\\n    \\\"city\\\": \\\"Miami\\\",\\n    \\\"state\\\": \\\"FL\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Phone.com’s standard phone service allows callers leave voicemail if the incoming call was not answered.  The /voicemail services show history of voicemail and allow users download voicemail for offline playback.","slug":"account-voicemail","type":"basic","title":"Voicemail"}

Voicemail

Phone.com’s standard phone service allows callers leave voicemail if the incoming call was not answered. The /voicemail services show history of voicemail and allow users download voicemail for offline playback.

[block:callout] { "type": "info", "body": "Note: This API is for users with Account Owner scope access token. Users with Extension User scope token should invoke the Voicemail API with the following definition:\n\nhttps://api.phone.com/v4/accounts/:account_id/extensions/:extension_id/voicemail" } [/block] ## Supported Services * [List Voicemail](doc:list-account-voicemail) * [Get Voicemail](doc:get-account-voicemail) * [Patch Voicemail](doc:patch-account-voicemail) ## Summary Object The Voicemail Summary Object is used to briefly represent a voicemail. It can be seen in several places throughout this API. Here are the properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-0": "`id`", "0-1": "String", "0-2": "Unique Voicemail ID. Read-only.", "1-0": "`download_url`", "1-1": "String", "1-2": "URL which may be used by the API user for voicemail download", "2-0": "`extension`", "2-1": "[Extension Summary Object](doc:account-extensions#section-summary-object)", "3-0": "`from`", "3-1": "[From Object](#section-from-object)", "2-2": "Extension where the voicemail is saved into.", "3-2": "The caller's information", "4-0": "`to`", "4-1": "String", "4-2": "The phone number where the caller is calling", "5-0": "`is_new`", "5-1": "Boolean", "5-2": "True when Voicemail is new; False when Voicemail has been listened", "6-0": "`created_at`", "6-1": "String", "6-2": "Date string representing the UTC time that the object was created in the Phone.com API system.", "7-0": "'folder'", "7-1": "String", "7-2": "Folder name where voicemail is saved", "8-0": "'duration'", "8-1": "Integer", "8-2": "Length of voicemail in seconds" }, "cols": 3, "rows": 9 } [/block] Here's an example: [block:code] { "codes": [ { "code": "{\n \"id\": \"ef8e574535c7bdfba131504a57026fda90c33370\",\n \"download_url\": \"https://api.phone.com/v4/accounts/337171/voicemail/ef8e574535c7bdfba131504a57026fda90c33370/download\",\n \"extension\": {\n \"id\": 709038,\n \"name\": \"Home 1\",\n \"extension\": 18,\n \"voip_id\": 337171,\n },\n \"from\": {\n \"number\": \"Unknown\",\n \"name\": \"V6211235150015316714\",\n \"city\": null,\n \"state\": null\n },\n \"to\": \"+17326830492\",\n \"is_new\": false,\n \"created_at\": 1498066543,\n \"folder\": \"INBOX\",\n \"duration\": 3,\n}", "language": "json" } ] } [/block] ## Full Object The Full Voicemail Object includes all of the properties in the [Voicemail Summary Object](#section-summary-object). ## From Object Each entry in a Voicemail's from list is an object with the following properties: [block:parameters] { "data": { "h-0": "Property", "h-1": "Description", "0-0": "`number`", "0-1": "The caller phone number", "1-0": "`name`", "1-1": "The name / caller ID of the caller", "2-0": "`city`", "2-1": "The city where the caller is from", "3-0": "`state`", "3-1": "The state where the caller is from" }, "cols": 2, "rows": 4 } [/block] Here's an example: [block:code] { "codes": [ { "code": "{\n \"number\": \"+17867093862\",\n \"name\": \"MIAMI FL\",\n \"city\": \"Miami\",\n \"state\": \"FL\"\n}", "language": "json" } ] } [/block]