Disconnect Toll-Free Numbers

Toll-Free (TF) Management

Manager your TF numbers. 

 

Endpoint and methods
  • POST: /_rest/v3/my/tf/disconnect

 

Parameters

Headers

  • 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

numbers

Array

An array of numbers on which to operate. 

 

Each item is of the following form:

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

Email optional

String

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

 

  • Must be scalar.

 

Notes optional

String

Notes regarding the fulfilment of this order.

 

  • Must be scalar.

 

referenceID optional

String

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

 

  • Must be scalar.

 

Request

{

    "numbers": [

        {

            "countryCode": "1",

            "number": "8885550001"

        },

        {

            "countryCode": "1",

            "number": "8885550002"

        }

    ]

}

 

Response example and schema

 

Success 200

 

Field

Type

Description

OrderID

Integer

 

 

Success Response
HTTP/1.1 200 OK

{

    "OrderID": 31542

}
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 409 Conflict

{

    "code": 409,

    "error": "One or more numbers is already pending disconnect."

}




HTTP/1.1 409 Conflict

{

    "code": 409,

    "error": "One or more numbers is not assigned to this account."

}
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) 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 'number' parameter must be 10 numeric digits."

}