TF List or Search

Toll-Free (TF) Management

Manager your TF numbers. 

 

List or Search 

Use TF_Management  to enumerate and search your toll-free inventory of numbers. 

 

Note: When more records are available on the next page, the API returns pageSize + 1 records.

 

Endpoint and methods
  • GET: /_rest/v3/my/tf

 

Parameters

Header

  • Accept: application/json
  • Authorization: xxxxxxxxxxxxxxxxx

Field

Type

Description

Accept
String

application/json

 

Authorization
String

Authorization token (see Authenticate)

 

Path

Field

Type

Description

Label optional

String[]

The label of the desired number(s).

 

Like optional
String[]

An alpha-numeric string to search for.

 

  • A single value will perfom a “starts-with” search.
  • Multiple values will perform an exact match for each name.

 

packageID optional
Integer[]

The package ID of the desired number(s).

 

Page optional
Integer

Which page of results to retrieve.

 

  • Default: 1
  • Min: 1
  • Must be scalar.

 

Note:When more records are available on the next page, this API will return pageSize + 1 records.

 

Default value: 1

 

pageSize optional
Integer

The maximum number of results to return per page.

 

  • Default: 100
  • Max: 100
  • Min: 1
  • Must be scalar.

 

Note:When more records are available on the next page, this API will return pageSize + 1 records.

 

Default value: 100

 

 
Request
/_rest/v3/my/tf?like=888&packageID=12345

{
    "like": "888",

    "packageID": 12345
}
Response example and schema

Success 200

 

Field

Type

Description

countryCode
Numeric

The number’s country code.

 

countryID
Integer

The number’s country ID.

 

countryName
String

The number’s country name.

 

e164
Numeric

The e.164 representation of the number.

 

label
String

The number’s label.

 

number
Numeric

The number.

 

packageID
Integer

The number’s package ID.

HTTP/1.1 200 OK

[

    {

        "countryCode": "1",

        "countryID": 255,

        "countryName": "United States",

        "e164": "+18887293863",

        "number": "8887293863",

        "packageID": 12345

    },

    {

        "countryCode": "1",

        "countryID": 255,

        "countryName": "United States",

        "e164": "+18887293864",

        "number": "8887293864",

        "packageID": 12345

    }

]
Error

Name

Type Description
code

Integer

Error code

error
String

Error description

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 must be formatted as a(n) integer."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}