Provision Numbers API Reference

This defines the Provision Numbers API:

• Request - Provision a Fax number.
• 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",
  "message": "Number has been provisioned.",
  "data": {
    "id": 782,
    "didid": 6283433,
    "did_group_id": 67,
    "country_code": "CAN",
    "city_name": "WINNIPEG",
    "area_code": "204",
    "number": "+12048134698",
    "type": "GEOGRAPHIC",
    "trunk_id": 8934
  }
}
	

Keys and Values

Response Messages