Disconnect DID Numbers

Use Disconnect DID to disengage a number from a customer. This releases it back into the carrier’s inventory after any applicable quarantine period.

Endpoint and Methods

POST: /_rest/v3/my/did/disconnect

Parameters

Headers

  • Accept: application/json
  • Authorization: xxxxxxxxxxxxxxxxx
  • Content-Type: application/json
Field Type Description
Accept STRING application/json
Authorization STRING Authorization token (for more information, seeAtmosphere® API Authentication)
Content-Type STRING application/json

Path

Field Type Description
numbers ARRAY

An array of numbers to provide E911 service for.

Each item is in the following form:

{

"countryCode": "1",

"number": "1112223456"

}

Email (optional) STRING An e-mail address to notify about changes in the order’s status.

Notes (optional)

STRING Notes regarding the fulfilment of the order.
referenceID (optional) STRING A non-empty string indicating your customer/external reference ID.

Request

Copy
POST /_rest/v3/my/did/disconnect

{

    "numbers": [

        {

            "countryCode": "1",

            "number": "2125550001"

        },

        {

            "countryCode": "1",

            "number": "2125550002"

        }

    ]

}

Response Example and Schema

Success 200

Field Type Description
order OBJECT A complex object identifying batch-specific and number provisioning details.
orderID INTEGER The overall ID associated with this order.
batches ARRAY An array of “batch” objects with associated number provisioning details.
batchID INTEGER The ID associated with this portion of the order (batch).
numbers ARRAY An array of objects specifying the numbers and provisioning attributes associated with this particular batch.
callerID (optional) STRING

The provisioning status of caller ID lookup service, if ordered/applicable (see network for value descriptions).

Allowed values: PENDING, PROVISIONED, QUEUED

Cnam (optional) STRING

The provisioning status of Caller ID Registration (CNAM) service, if ordered/applicable (see network for value descriptions).

Allowed values: PENDING, PROVISIONED, QUEUED

countryCode NUMERIC The number’s country code.
directoryListing (optional) STRING

The provisioning status of Directory Listing service, if ordered/applicable (see network for value descriptions).

Allowed values: PENDING, PROVISIONED, QUEUED

e164 NUMERIC The e.164 representation of the number.
E911 (optional) STRING

The provisioning status of 911 service, if ordered/applicable (see network for value descriptions).

Allowed values: PENDING, PROVISIONED, QUEUED

e911Address (optional) OBJECT If the order is adding or changing 911 service, this is the associated address.
name STRING The name/label of the 911 registration address.
address1 STRING The first line of the 911 registration address.
address2 STRING The second line of the 911 registration address.
city STRING The city of the 911 registration address.
state STRING The state of the 911 registration address.
zip STRING The zip code (postal code) of the 911 registration address.
network STRING

The number’s provisioning status.

Allowed values: PENDING, PROVISIONED, QUEUED

  • PENDING: Our services and systems have begun the necessary work to provide this service.
  • PROVISIONED: Our services and systems have completed the necessary work and the service is currently active, unless altered by a later order.
  • QUEUED: Our services and systems are aware that work needs to occur, but the work has not been started yet.
number OBJECT The number.

Success Response

Copy
HTTP/1.1 200 OK

{

  "orderID": 12345,

  "batches": [

    {

      "batchID": 23456,

      "numbers": [

        {

          "callerID": "QUEUED",

          "cnam": null,

          "countryCode": "1",

          "directoryListing": null,

          "e164": "+14084744638",

          "e911": "QUEUED",

          "e911Address": null,

          "network": "PENDING",

          "number": "4084744638"

        },

        {

          "callerID": "QUEUED",
      
  "cnam": null,

          "countryCode": "1",

          "directoryListing": null,

          "e164": "+14084744638",

          "e911": "QUEUED",

          "e911Address": null,

          "network": "PENDING",

          "number": "4084744638"

        }

      ]

    }

  ]

}

Error

Name Type Description
code INTEGER Error code
error STRING Error description

Code 401 Response

Copy
HTTP/1.1 401 Unauthorized

{

    "code": 401,

    "error": "Unauthorized"

}

 

Copy
HTTP/1.1 401 Unauthorized

{

    "code": 401,

    "error": "Session Expired"

}

Code 409 Response

Copy
HTTP/1.1 409 Conflict

{

    "code": 409,

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

}

 

Copy
HTTP/1.1 409 Conflict

{

    "code": 409,

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

}

Code 422 Response

Copy
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}

 

Copy
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}

 

Copy
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}

 

Copy
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}

 

Copy
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The 'number' parameter must be 10 numeric digits."

}