{"_id":"59e03227a7ec6300103d292e","project":"55c8cff571d7580d0063a5e5","version":{"_id":"57624356653c2d2200fec79c","__v":22,"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","5ba8fd1a4c8c220003a08f0f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"4.0.0","version":"4"},"category":{"_id":"59e0323d93da1f001c9ec170","project":"55c8cff571d7580d0063a5e5","version":"57624356653c2d2200fec79c","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-10-13T03:25:49.733Z","from_sync":false,"order":16,"slug":"fax","title":"Account Fax"},"user":"56f99ab84d2b4f3400edb636","githubsync":"","__v":0,"parentDoc":null,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-10-13T03:25:27.868Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"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/fax\"\n}\n[/block]\n## Supported Services\n* [List Fax](doc:list-account-fax) \n* [Get Fax](doc:get-account-fax) \n* [Patch Fax](doc:patch-account-fax) \n* [Delete Fax](doc:delete-account-fax) \n* [Download Fax](doc:download-account-fax) \n\n## Summary Object\nThe Fax 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 Fax ID. Read-only.\",\n    \"1-0\": \"`extension`\",\n    \"1-1\": \"Integer\",\n    \"2-0\": \"`from`\",\n    \"2-1\": \"String\",\n    \"1-2\": \"ID of extension where the Fax is saved into.\",\n    \"2-2\": \"Phone number from where the Fax was sent in E.164 format\",\n    \"3-0\": \"`to`\",\n    \"3-1\": \"String\",\n    \"3-2\": \"Phone number to where the Fax was sent in E.164 format\",\n    \"4-0\": \"`is_new`\",\n    \"4-1\": \"Boolean\",\n    \"4-2\": \"True when Fax is new; False when Fax has been viewed or downloaded\",\n    \"5-0\": \"`created_at`\",\n    \"5-1\": \"String\",\n    \"5-2\": \"Date string representing the UTC time that the object was created in the Phone.com API system.\",\n    \"6-0\": \"`pages`\",\n    \"6-1\": \"Integer\",\n    \"6-2\": \"Number of pages of the Fax\"\n  },\n  \"cols\": 3,\n  \"rows\": 7\n}\n[/block]\nHere's an example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"6a2d53d2ba5efaeecbb5e74039dd7e88eccd1393\\\",\\n    \\\"extension\\\": 1778029,\\n    \\\"from\\\": \\\"+19085323133\\\",\\n    \\\"to\\\": \\\"+17327076616\\\",\\n    \\\"is_new\\\": true,\\n    \\\"pages\\\": 7,\\n    \\\"created_at\\\": 1507867719,\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n## Full Object\nThe Full Voicemail Object includes all of the properties in the [Fax Summary Object](#section-summary-object).\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`extension`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"[Extension Object](#section-extension-object), see below for details\",\n    \"0-2\": \"Details of extension where the Fax is saved into.\",\n    \"1-1\": \"[From Object](#section-from-object), see below for details\",\n    \"1-2\": \"Details of Phone number of who sent the Fax in E.164 format\",\n    \"1-0\": \"`from`\",\n    \"2-0\": \"`form_data`\",\n    \"2-1\": \"[Form Data Object](#section-form_data-object), see below for details.\\n\\nNote:  This object only appears for outbound Fax\",\n    \"2-2\": \"Details of the Form Sheet data where user entered before sending the Fax via Phone.com Control Panel\"\n  },\n  \"cols\": 3,\n  \"rows\": 3\n}\n[/block]\n## Extension Object\nThe Extension Object includes detailed properties of an extension.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`id`\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"0-1\": \"String\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"2-0\": \"`extension`\",\n    \"2-1\": \"Integer\",\n    \"3-0\": \"`voip_id`\",\n    \"3-1\": \"Integer\",\n    \"0-2\": \"Unique extension ID\",\n    \"1-2\": \"Name of extension\",\n    \"2-2\": \"Extension number\",\n    \"3-2\": \"ID of API account who owns this extension\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n## From Object\nThe From Object includes detailed properties of person who sent the Fax.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"0-0\": \"`number`\",\n    \"0-1\": \"String\",\n    \"1-0\": \"`name`\",\n    \"1-1\": \"String\",\n    \"2-0\": \"`city`\",\n    \"2-1\": \"String\",\n    \"3-0\": \"`state`\",\n    \"3-1\": \"State\",\n    \"h-2\": \"Description\",\n    \"0-2\": \"Phone number from where the Fax was sent in E.164 format\",\n    \"1-2\": \"The name / caller ID of the person who sent the Fax\",\n    \"2-2\": \"The city where the Fax is from.  Null if empty\",\n    \"3-2\": \"The state where the Fax is from.  Null if empty\"\n  },\n  \"cols\": 3,\n  \"rows\": 4\n}\n[/block]\n## Form_Data Object\nDetails of the Form Sheet data where user entered before sending the Fax via Phone.com Control Panel.  This object only appears in the response for outbound Fax.  Same info appears on the Fax Cover Sheet.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`from_company`\",\n    \"0-1\": \"String\",\n    \"0-2\": \"Company where Fax was from\",\n    \"h-0\": \"Property\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Description\",\n    \"1-0\": \"`cover_date`\",\n    \"2-0\": \"`subject`\",\n    \"3-0\": \"`fax_cover`\",\n    \"4-0\": \"`memo`\",\n    \"5-0\": \"`cover_time`\",\n    \"6-0\": \"`to_name`\",\n    \"7-0\": \"`to_company`\",\n    \"8-0\": \"`from_name`\",\n    \"9-0\": \"`from_phone`\",\n    \"1-1\": \"String\",\n    \"2-1\": \"String\",\n    \"3-1\": \"\\\"on\\\" or \\\"off\\\"\",\n    \"4-1\": \"String\",\n    \"5-1\": \"String\",\n    \"6-1\": \"String\",\n    \"7-1\": \"String\",\n    \"8-1\": \"String\",\n    \"9-1\": \"String\",\n    \"1-2\": \"Date when Fax was sent\",\n    \"2-2\": \"Subject of Fax\",\n    \"3-2\": \"Include Cover Sheet ?\",\n    \"4-2\": \"Memo of Fax\",\n    \"5-2\": \"Time when Fax was sent\",\n    \"6-2\": \"Name to whom Fax was sent\",\n    \"7-2\": \"Company to whom Fax was sent\",\n    \"8-2\": \"Name from who Fax was sent\",\n    \"9-2\": \"Phone number from where Fax was sent\"\n  },\n  \"cols\": 3,\n  \"rows\": 10\n}\n[/block]\nHere's an example of the [Fax Full Object](#section-full-object).\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"id\\\": \\\"6a2d53d2ba5efaeecbb5e74039dd7e88eccd1393\\\",\\n    \\\"extension\\\": {\\n        \\\"id\\\": 1778029,\\n        \\\"name\\\": \\\"default extension\\\",\\n        \\\"extension\\\": 500,\\n        \\\"voip_id\\\": 1330103,\\n    },\\n    \\\"from\\\": {\\n        \\\"number\\\": \\\"+19085323133\\\",\\n        \\\"name\\\": \\\"Test\\\",\\n        \\\"city\\\": null,\\n        \\\"state\\\": null\\n    },\\n    \\\"to\\\": \\\"+17327078818\\\",\\n    \\\"is_new\\\": true,\\n    \\\"pages\\\": 7,\\n    \\\"created_at\\\": 1507867719,\\n    \\\"form_data\\\": {\\n        \\\"from_company\\\": \\\"\\\",\\n        \\\"cover_date\\\": \\\"October 12, 2017\\\",\\n        \\\"subject\\\": \\\"Test Outbound Fax\\\",\\n        \\\"fax_cover\\\": \\\"on\\\",\\n        \\\"memo\\\": \\\"\\\",\\n        \\\"cover_time\\\": \\\"09:08 PM\\\",\\n        \\\"to_name\\\": \\\"Prod Test Account\\\",\\n        \\\"to_company\\\": \\\"\\\",\\n        \\\"from_name\\\": \\\"API QA Account\\\",\\n        \\\"from_phone\\\": \\\"(908) 532-3133\\\"\\n    }\\n}\\n\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]","excerpt":"Phone.com customers can fax outbound documents via the Control Panel; They can also receive incoming fax into one of the Extension mailbox.  The Fax API service allows users list all fax in the account, change the 'new' status of a fax, download a fax and delete a fax.","slug":"account-fax","type":"basic","title":"Fax"}

Fax

Phone.com customers can fax outbound documents via the Control Panel; They can also receive incoming fax into one of the Extension mailbox. The Fax API service allows users list all fax in the account, change the 'new' status of a fax, download a fax and delete a fax.

[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/fax" } [/block] ## Supported Services * [List Fax](doc:list-account-fax) * [Get Fax](doc:get-account-fax) * [Patch Fax](doc:patch-account-fax) * [Delete Fax](doc:delete-account-fax) * [Download Fax](doc:download-account-fax) ## Summary Object The Fax 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 Fax ID. Read-only.", "1-0": "`extension`", "1-1": "Integer", "2-0": "`from`", "2-1": "String", "1-2": "ID of extension where the Fax is saved into.", "2-2": "Phone number from where the Fax was sent in E.164 format", "3-0": "`to`", "3-1": "String", "3-2": "Phone number to where the Fax was sent in E.164 format", "4-0": "`is_new`", "4-1": "Boolean", "4-2": "True when Fax is new; False when Fax has been viewed or downloaded", "5-0": "`created_at`", "5-1": "String", "5-2": "Date string representing the UTC time that the object was created in the Phone.com API system.", "6-0": "`pages`", "6-1": "Integer", "6-2": "Number of pages of the Fax" }, "cols": 3, "rows": 7 } [/block] Here's an example: [block:code] { "codes": [ { "code": "{\n \"id\": \"6a2d53d2ba5efaeecbb5e74039dd7e88eccd1393\",\n \"extension\": 1778029,\n \"from\": \"+19085323133\",\n \"to\": \"+17327076616\",\n \"is_new\": true,\n \"pages\": 7,\n \"created_at\": 1507867719,\n}", "language": "json" } ] } [/block] ## Full Object The Full Voicemail Object includes all of the properties in the [Fax Summary Object](#section-summary-object). [block:parameters] { "data": { "0-0": "`extension`", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-1": "[Extension Object](#section-extension-object), see below for details", "0-2": "Details of extension where the Fax is saved into.", "1-1": "[From Object](#section-from-object), see below for details", "1-2": "Details of Phone number of who sent the Fax in E.164 format", "1-0": "`from`", "2-0": "`form_data`", "2-1": "[Form Data Object](#section-form_data-object), see below for details.\n\nNote: This object only appears for outbound Fax", "2-2": "Details of the Form Sheet data where user entered before sending the Fax via Phone.com Control Panel" }, "cols": 3, "rows": 3 } [/block] ## Extension Object The Extension Object includes detailed properties of an extension. [block:parameters] { "data": { "0-0": "`id`", "h-0": "Property", "h-1": "Type", "h-2": "Description", "0-1": "String", "1-0": "`name`", "1-1": "String", "2-0": "`extension`", "2-1": "Integer", "3-0": "`voip_id`", "3-1": "Integer", "0-2": "Unique extension ID", "1-2": "Name of extension", "2-2": "Extension number", "3-2": "ID of API account who owns this extension" }, "cols": 3, "rows": 4 } [/block] ## From Object The From Object includes detailed properties of person who sent the Fax. [block:parameters] { "data": { "h-0": "Property", "h-1": "Type", "0-0": "`number`", "0-1": "String", "1-0": "`name`", "1-1": "String", "2-0": "`city`", "2-1": "String", "3-0": "`state`", "3-1": "State", "h-2": "Description", "0-2": "Phone number from where the Fax was sent in E.164 format", "1-2": "The name / caller ID of the person who sent the Fax", "2-2": "The city where the Fax is from. Null if empty", "3-2": "The state where the Fax is from. Null if empty" }, "cols": 3, "rows": 4 } [/block] ## Form_Data Object Details of the Form Sheet data where user entered before sending the Fax via Phone.com Control Panel. This object only appears in the response for outbound Fax. Same info appears on the Fax Cover Sheet. [block:parameters] { "data": { "0-0": "`from_company`", "0-1": "String", "0-2": "Company where Fax was from", "h-0": "Property", "h-1": "Type", "h-2": "Description", "1-0": "`cover_date`", "2-0": "`subject`", "3-0": "`fax_cover`", "4-0": "`memo`", "5-0": "`cover_time`", "6-0": "`to_name`", "7-0": "`to_company`", "8-0": "`from_name`", "9-0": "`from_phone`", "1-1": "String", "2-1": "String", "3-1": "\"on\" or \"off\"", "4-1": "String", "5-1": "String", "6-1": "String", "7-1": "String", "8-1": "String", "9-1": "String", "1-2": "Date when Fax was sent", "2-2": "Subject of Fax", "3-2": "Include Cover Sheet ?", "4-2": "Memo of Fax", "5-2": "Time when Fax was sent", "6-2": "Name to whom Fax was sent", "7-2": "Company to whom Fax was sent", "8-2": "Name from who Fax was sent", "9-2": "Phone number from where Fax was sent" }, "cols": 3, "rows": 10 } [/block] Here's an example of the [Fax Full Object](#section-full-object). [block:code] { "codes": [ { "code": "{\n \"id\": \"6a2d53d2ba5efaeecbb5e74039dd7e88eccd1393\",\n \"extension\": {\n \"id\": 1778029,\n \"name\": \"default extension\",\n \"extension\": 500,\n \"voip_id\": 1330103,\n },\n \"from\": {\n \"number\": \"+19085323133\",\n \"name\": \"Test\",\n \"city\": null,\n \"state\": null\n },\n \"to\": \"+17327078818\",\n \"is_new\": true,\n \"pages\": 7,\n \"created_at\": 1507867719,\n \"form_data\": {\n \"from_company\": \"\",\n \"cover_date\": \"October 12, 2017\",\n \"subject\": \"Test Outbound Fax\",\n \"fax_cover\": \"on\",\n \"memo\": \"\",\n \"cover_time\": \"09:08 PM\",\n \"to_name\": \"Prod Test Account\",\n \"to_company\": \"\",\n \"from_name\": \"API QA Account\",\n \"from_phone\": \"(908) 532-3133\"\n }\n}\n", "language": "json" } ] } [/block]