{"__v":35,"_id":"558a0023d861910d00112511","api":{"auth":"required","params":[],"results":{"codes":[]},"settings":"","url":""},"body":"The OnlineFaxes API is a secured and simple API to use web interface based on HTTP GET/POST operations for online fax services. The API is compatible with just about any operating system platform and many programming languages. Currently, This API is being offered to customers and partners who will integrate their systems with OnlineFaxes\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Fax API Features\"\n}\n[/block]\nOnlineFaxes  API is focused around simple resource elements. They are: \n* SendFax\n* DownloadFax\n* DeleteFax\n* GetFaxDetails\n* FaxStatus\n* GetFaxList\n\nEach resource supports several parameters within the URI scheme as well as various data formats (JSON, XML, simple URL encoded data, etc.) The next sections show each of the API calls and their supported parameters, including example responses.\nThe base URL for this web interface is: [https://api.onlinefaxes.com/v2](https://api.onlinefaxes.com/v2)\n\n**Note:** For sending fax, all parameters in POST operations use both: \n* form-urlencoded data  (\"application/x-www-form-urlencoded\" content-type in the HTTP header). \n* multipart MIME data (\"multipart/form-data\" content-type in the HTTP header). \nAll responses that return Date/Time objects are in PST.\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Fax API Quick Start\"\n}\n[/block]\n**Sample API Request to send fax using OnlineFaxes API with form-urlencoded data:**\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"curl -XPOST \\n-H 'Authorization: ofx xxxxxxxxxxxxxxx_yourAccessToken' \\n-H 'content-type: application/x-www-form-urlencoded' \\n-d 'senderName=Mr Snow&senderCompanyName=Snow White Club&faxSubject=Snow Fax&faxNotes=Online Faxes is coming to Alaska&recipientName=OFX&recipientFaxNo=x(xxx)xxxxxxx'\\n\\n'https://api.onlinefaxes.com/v2/fax/async/sendfax/simplemodel'\\n\\n\",\n      \"language\": \"curl\",\n      \"name\": \"Request-cURL\"\n    }\n  ]\n}\n[/block]\n**Sample of API Respond after sending fax to recipient:***\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"{\\n    \\\"Item1\\\": \\\"OK\\\",\\n    \\\"Item2\\\": \\\"208120889092\\\"\\n}\",\n      \"language\": \"json\",\n      \"name\": \"Respond-JSON\"\n    }\n  ]\n}\n[/block]\n**Note:** OnlineFaxes API will respond with a unique Fax ID that can be used to query the status of the fax after submission. `m_Item1` is for the success status while `m_Item2` is for Fax ID","category":"558a0022d861910d001124f9","createdAt":"2015-04-14T06:59:17.695Z","excerpt":"","githubsync":"","hidden":false,"link_external":false,"link_url":"","order":0,"project":"552cbac45945552f00b8143f","slug":"getting-started","sync_unique":"","title":"Welcome to OnlineFaxes API","type":"basic","updates":[],"user":"552cba5cd9f89e0d0015a67c","version":"558a0022d861910d001124f8","childrenPages":[]}

Welcome to OnlineFaxes API


The OnlineFaxes API is a secured and simple API to use web interface based on HTTP GET/POST operations for online fax services. The API is compatible with just about any operating system platform and many programming languages. Currently, This API is being offered to customers and partners who will integrate their systems with OnlineFaxes [block:api-header] { "type": "basic", "title": "Fax API Features" } [/block] OnlineFaxes API is focused around simple resource elements. They are: * SendFax * DownloadFax * DeleteFax * GetFaxDetails * FaxStatus * GetFaxList Each resource supports several parameters within the URI scheme as well as various data formats (JSON, XML, simple URL encoded data, etc.) The next sections show each of the API calls and their supported parameters, including example responses. The base URL for this web interface is: [https://api.onlinefaxes.com/v2](https://api.onlinefaxes.com/v2) **Note:** For sending fax, all parameters in POST operations use both: * form-urlencoded data ("application/x-www-form-urlencoded" content-type in the HTTP header). * multipart MIME data ("multipart/form-data" content-type in the HTTP header). All responses that return Date/Time objects are in PST. [block:api-header] { "type": "basic", "title": "Fax API Quick Start" } [/block] **Sample API Request to send fax using OnlineFaxes API with form-urlencoded data:** [block:code] { "codes": [ { "code": "curl -XPOST \n-H 'Authorization: ofx xxxxxxxxxxxxxxx_yourAccessToken' \n-H 'content-type: application/x-www-form-urlencoded' \n-d 'senderName=Mr Snow&senderCompanyName=Snow White Club&faxSubject=Snow Fax&faxNotes=Online Faxes is coming to Alaska&recipientName=OFX&recipientFaxNo=x(xxx)xxxxxxx'\n\n'https://api.onlinefaxes.com/v2/fax/async/sendfax/simplemodel'\n\n", "language": "curl", "name": "Request-cURL" } ] } [/block] **Sample of API Respond after sending fax to recipient:*** [block:code] { "codes": [ { "code": "{\n \"Item1\": \"OK\",\n \"Item2\": \"208120889092\"\n}", "language": "json", "name": "Respond-JSON" } ] } [/block] **Note:** OnlineFaxes API will respond with a unique Fax ID that can be used to query the status of the fax after submission. `m_Item1` is for the success status while `m_Item2` is for Fax ID