List Numbers API Reference

This defines the List Numbers API:

• Request - Get list of numbers.
• Response - ensure that your request to the Fax API was successful.

Request

A Fax API request looks like:

This request contains:

• Parameters
• Authentication information
• Security
• Encoding

Parameters

The following table shows the parameters you use in the request:

Authentication information

The following table shows the information for authentication:

You find your Key in Dashboard.

Security

To ensure privacy, you must use HTTPS for all Faxto API requests.

Encoding

You submit all requests with a POST or GET call using UTF-8 encoding and URL encoded values.

Response

We support JSON ONLY responses

{
  "status": "success",
  "numbers": [
    {
      "id": 775,
      "order_reference": null,
      "country_code": "CAN",
      "country": "CANADA",
      "city_name": null,
      "area_code": "204",
      "did_group_id": 67,
      "did_number": "+12048134699",
      "expiration_date": "2017-07-30",
      "status": "Active"
    },
    {
      "id": 776,
      "order_reference": null,
      "country_code": "CAN",
      "country": "CANADA",
      "city_name": null,
      "area_code": "204",
      "did_group_id": 67,
      "did_number": "+12048134700",
      "expiration_date": "2017-07-30",
      "status": "Active"
    }
  ],
  "meta": {
    "pagination": {
      "total": 7,
      "count": 2,
      "per_page": 2,
      "current_page": 2,
      "total_pages": 4,
      "links": {
        "previous": "https://fax.to/api/v2/numbers?page=1",
        "next": "https://fax.to/api/v2/numbers?page=3"
      }
    }
  }
}
	

Keys and Values

Response Messages