Reserve TF Number

Toll-Free (TF)

Toll-Free (TF) numbers are phone numbers within the US that do not incur costs to the caller.  

Note: These phone numbers usually charge the person or business being called.

Reserve TF Number

Search and identify your unique Toll-Free numbers and then hold onto them with Reserve TF Number.  Like a shopping cart, reserving allows you to think on them before someone else buys them.

 

Endpoint and methods
POST  /_rest/v4/carrier/tf/reservations

 

Parameters
 

Headers

Accept: application/json

Authorization: xxxxxxxxxxxxxxxxx

Content-Type: application/json

Header

 

Field

Type

Description

Accept

 

String

application/json

Authorization

 

 

String

Authorization token (see Authenticate)

Content-Type

String

application/json

 

Parameter

 

Field

Type

Description

endpoints

 

E.164[]

The endpoints to reserve.

reservationID optional

String

A Universally Unique Identifier (UUID) to associate with the reserved endpoints. (See Universally unique identifier)

{

    "endpoints": [

        "+18887293863",

        "+18887293864"

    ]

}
{

    "endpoints": [

        "+18885551201",

        "+18885551202"

    ],

    "reservationID": "F78793B1-7E84-11E6-B908-52540029234D"

}

Success 200

 

Field

Type

Description

endpoints

 

 

Array

A list containing the reserved endpoint(s).

endpoint

 

 

Numeric

The e.164 representation of the endpoint.

geo

 

 

Object

Geographical information about the endpoint.

city

 

Null

The endpoint’s city.

country

 

String

The endpoint’s country.

stateProvince

 

Null

The endpoint’s State/Province.

expirationDate

 

 

DateTime

The ISO 8601 date the reservation will expire.

reservationID

 

 

 

 

String

The Universally Unique Identifier (UUID) associated with the endpoints. (see Universally unique identifier)

reservedDate

DateTime

The ISO 8601 date the reservation was made.

 

HTTP/1.1 200 OK

[

    {

        "endpoints": [

            {

                "endpoint": "+18887293863",

                "geo": {

                    "city": null,

                    "country": "US",

                    "stateProvince": null

                }

            },

            {

                "endpoint": "+18887293864",

                "geo": {

                    "city": null,

                    "country": "US",

                    "stateProvince": null

                }

            }

        ],

        "expirationDate": "2015-08-16T23:17:01Z",

        "reservationID": "F78793B1-7E84-11E6-B908-52540029234D",

        "reservedDate": "2015-08-16T22:47:01Z"

    }

]

        "expirationDate": "2015-08-16T23:17:01Z",

        "reservationID": "F78793B1-7E84-11E6-B908-52540029234D",

        "reservedDate": "2015-08-16T22:47:01Z"

    }

]

Error 

 

Name

Type

Description

code

 

Integer

Error code

error

String

Error description

HTTP/1.1 400 Bad Request

{

    "code": 400,

    "error": "Number(s) not available."

}

HTTP/1.1 401 Unauthorized

{

    "code": 401,

    "error": "Unauthorized"

}

HTTP/1.1 401 Unauthorized

{

    "code": 401,

    "error": "Session Expired"

}
HTTP/1.1 406 Not Acceptable

{

    "code": 406,

    "error": "Not Acceptable"

}
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter is required."

}


HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be formatted as a(n) array."

}


HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The 'endpoints' parameter must be a number(s) in E.164 format."