Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.7 KB

File metadata and controls

42 lines (24 loc) · 1.7 KB

Phaxio

AppVeyor build status

Build Status

Phaxio is the only cloud based fax API designed for developers. This is the .NET client library for Phaxio.

Getting started

First, sign up if you haven't already.

Second, go to api settings and get your key and your secret.

Third, install this client with Nuget:

Install-Package Phaxio

For basic usage, use this guide if you're a C# developer or this guide if you're a VB.NET developer.

Errors

Sometimes errors will occur, whether it's network timeouts or bad requests. All operations will throw an exception if a network or client error occurs. Some operations return data to you, such as a byte array representing a PDF. If those requests fail due to an authentication failure, a malformed number, insufficient funds, rate limiting, etc., they'll throw an ApplicationException with an error message describing the problem.

For those requests returning a Result object, that will have a bool named Success and a string called Message that will tell you the result of the operation.

Rate limiting

The Phaxio API is rate limited. If you make too many requests too quickly, you might receive this error. Check the exception message, wait a second, and then try your request again.

Writing callbacks (webhooks)

Writing a callback to get fax send or recieve events is simple. Read this handy guide to get started.

© 2016 Phaxio