Purchase TF Numbers

After finding, or finding and reserving your unique TF numbers, use Purchase TF Numbers to buy them.   

Endpoint and methods
POST /_rest/v3/my/tf/orders

Parameters

 

Header

Accept: application/json

Authorization: xxxxxxxxxxxxxxxxx

Content-Type: application/json

 

Field

Type

Description

Accept

 

String

application/json

Authorization


String

Authorization token (see Authenticate)

Content-Type

String

application/json

 
Path

 

Field

Type

Description

Email optional

String

An e-mail address to notify about changes in this order’s status.

 

  • Must be scalar.

 

myRespOrg optional

Boolean

Should numbers be provisioned to customer’s RespOrg instead of carrier RespOrg?

 

  • Defaults to false.

 

Notes optional

String

Notes regarding the fulfilment of this order.

 

  • Must be scalar.

 

numbers

Array

An array of reserved numbers to order

 

  • Mutually exclusive with quantity and reservations
  • Each item is of the following form:
{

    "countryCode": "1",
    "number": "8882223456"
}

packageID

Integer

The target packageID to order numbers for.

 

  • Must be scalar.

 

quantity

Integer

The quantity of numbers to order.

 

  • Must be scalar.
  • Mutually exclusive with numbers and reservations.

 

reservations

String

One or more reservationIDs indicating the numbers to order

 

  • Mutually exclusive with numbers and quantity

 

referenceIDoptional

String

A non-empty string indicating your reference ID or code.

 

  • Must be scalar.

 

serviceArea

Integer

The service area for desired number(s) (see Lookups – Service Area).

 

  • Must be scalar.

 

 

{

    "reservationID": [

        "BD929A2A-7F48-11E6-B908-52540029234D",

        "0F85813F-7E8B-11E6-B908-52540029234D"

    ],

    "packageID": 1234567,

    "serviceArea": 4

}
{

    "quantity": 1,

    "packageID": 1234567,

    "serviceArea": 4

}

Field

Type

Description

Order ID

Integer

 

 

HTTP/1.1 200 OK

{

    "orderID": 287225,

    "batches": [

        { "batchID": 31458 },

        { "batchID": 31460 },

        { "batchID": 31462 }

    ]

}


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 402 Payment Required

{

    "code": 402,

    "error": "Order blocked; trial limit realized.  Limit: %d seats."

}


HTTP/1.1 402 Payment Required

{

    "code": 402,

    "error": "Order too large; trial limit exceeded.  Available: %d seats."

}
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 scalar."

}


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) string."

}


HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%' parameter is required for each Number object."

}


HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The 'countryCode' parameter must match one of the following values: 1"

}


HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The 'serviceArea' parameter must match one of the following values: 1, 2, 3, 4, 5"

}