README-vb.md

Usage examples - Visual Basic .NET

Basics

The PhaxioClient class is the entry point for any Phaxio operation.

Dim phaxio = New PhaxioClient("secret", "key")

Getting your account status

Dim status = phaxio.Account.Status
Console.WriteLine(string.Format("Balance: {0}", status.Balance))

Faxes

Sending a fax

At the heart of the Phaxio API is the ability to send a fax:

Dim fax = phaxio.Fax.Create(to:="8088675309", file:=New IO.FileInfo("form1234.pdf"))

The fax object can be used to reference your fax later. Well, now, wasn't that simple? You can also pass in a Dictionary(Of string, object) to create your fax:

Dim faxConfig = New Dictionary<string, object> From
{
    { "To", "8088675309" },
    { "File", "form1234.pdf" }
}
Dim fax = phaxio.Fax.Create(faxConfig)

If you have more than one file, you can pass in a list and Phaxio will concatenate them into one fax:

Dim fax = phaxio.Fax.Create(to:="8088675309", files:=New List(Of IO.FileInfo) From {pdf1, pdf2}, callerId:="2125552368")

If you have a bunch of faxes going to one number, you might want to check out batching. You first specify a batch delay. Then, you send as many faxes as you'd like to the number in question, and when you're finished and the batch delay is expired, Phaxio will send them all as one long fax. Here's what that would look like:

Dim fax1Config = New Dictionary(Of string, object) From
{
    { "To", "8088675309" },
    { "File", pdf1 },
    { "BatchDelaySeconds", 30 }
}
Dim fax2Config = New Dictionary(Of string, object) From
{
    { "To", "8088675309" },
    { "File", pdf2 },
    { "BatchDelaySeconds", 30 }
}
phaxio.Fax.Create(fax1Config)
phaxio.Fax.Create(fax2Config)

The machine at 808-867-5309 will see pdf1 and pdf2 as one long fax.

Querying sent faxes

To see your sent faxes after you've sent it, call Retrieve on the Faxes property:

Dim fax = phaxio.Fax.Retrieve("1234")

This returns a single Fax or throws a NotFound exception. You can also add filters:

Dim faxes = phaxio.Fax.List(createdBefore:=DateTime.Now)

This returns an IEnumerable(Of Fax).

Downloading a fax

To retrieve the fax file after you've sent it, call the File method on the Fax instance:

Dim file = phaxio.Fax.Retrieve("1234").File

File is a FaxFile object representing your fax. You can call the Bytes property which returns a byte array of the PDF that you can write to disk or store in a database.

You can also specify which format you'd like using the File property on the Fax instance:

Dim file = phaxio.Fax.Retrieve("1234").File.SmallJpeg

Specify SmallJpeg for a small JPEG, LargeJpeg for a large JPEG, or Pdf for PDF.

Resending a fax

You can resend a fax:

fax.Resend()

Cancelling a fax

You can cancel a fax:

fax.Cancel()

Deleting a fax's files

You can delete a fax:

fax.File.Delete()

Deleting a fax

You can delete a fax:

fax.Delete()

Numbers

Getting area codes

If you want to know what area codes are available for purchase, you can call this property:

Dim areaCodes = phaxio.Public.AreaCode.List()

This returns a IEnumberable of AreaCode objects. You can also optionally request tollfree numbers:

Dim areaCodes = phaxio.Public.AreaCode.List(tollFree:=true)

You can specify the state (and you must specify either the country code or the country if you do):

Dim areaCodes = phaxio.Public.AreaCode.List(state:="MA", country:="US")

Or both:

Dim areaCodes = phaxio.Public.AreaCode.List(tollFree:=true, state:="MA", country:="US")

Provisioning a number

You can ask Phaxio to get you a new number (you must specify an area code and country code):

Dim newNumber = phaxio.PhoneNumber.Create("808", "1")

The call returns a PhoneNumber object representing your new number.

You can also specify a callback URL that will be called when a fax is recieved at the new number (this will override the default callback URL).

Dim newNumber = phaxio.PhoneNumber.Create("808", "1", callbackUrl:="https://example.com/callback")

Listing your numbers

To get a list of your numbers, you can run this method:

Dim numbers = phaxio.PhoneNumber.List()

which will return a IEnumberable with all of your numbers.

You can specify an country code to search in:

Dim numbers = phaxio.PhoneNumber.List(countryCode:="1")

You can specify an area code to search in (you must also specify the country code):

Dim numbers = phaxio.PhoneNumber.List(areaCode:="808", countryCode:="1")

or you can retrieve a specific number:

Dim number = phaxio.PhoneNumber.Retrieve("8088675309")

Release number

You can a release number (give it back to Phaxio):

number.Release()

This operation will throw an exception if the number cannot be released.

PhaxCodes

Creating a PhaxCode

Creating a PhaxCode is simple, just pass the metadata that you want associated with your PhaxCode:

Dim phaxCode = phaxio.PhaxCode.Create("code-for-form1234")

You can also get the image directly:

File.WriteAllBytes(@"C:\temp\phaxCode.png", phaxCode.Png)

To get the properties of the newly generated code:

Dim phaxCode = phaxio.PhaxCode.Retrieve(codeId)

To download the PNG of this newly generated code:

Dim codeBytes = phaxio.PhaxCode.Retrieve(codeId).Png

Misc

Getting supported countries

If you want to know what countries are supported by Phaxio, you can call this method:

Dim supportedCountries = phaxio.Public.SupportedCountry.List()

This returns a IEnumerable of Country objects that have pricing and the services available.

Testing callbacks (web hooks)

So you've written a callback or a webhook you'd like tested. It's simple to have Phaxio send you a fax:

Dim testFax = phaxio.Fax.TestRecieveCallback(New FileInfo("test-fax.pdf"))

This returns a Fax object. This will call your default account callback. If you've specified a callback for an individual number and you'd like to test that callback, you can specify it with the to parameter:

Dim testFax = phaxio.Fax.TestRecieveCallback(New FileInfo("test-fax.pdf"), to:="8088675309")

You can also fake who the fax is from:

Dim testFax = phaxio.Fax.TestRecieveCallback(New FileInfo("test-fax.pdf"), from:="2125552368")

© 2016-2017 Phaxio