Remove CNAM

Remove CNAM

Remove the CNAM service from a list of numbers.

 

Endpoint and methods
  • DELETE: /_rest/v3/my/did/cnam

 

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

numbers

Array

An array of reserve numbers on which to operate. 

 

Each item is of the following form:

{

    "countryCode": "1",

    "number": "2125550001"

}

Email optional

String

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

 

Notes optional


String

Notes regarding the fulfilment of this order.

referenceID optional

String

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

 

Request
{

    "numbers": [

        {

            "countryCode": "1",

            "number": "2125550001"

        },

        {

            "countryCode": "1",

            "number": "2125550002"

        }

    ]

}
Response example and schema

 

Success 200

 

Field

Type

Description

OrderID
Integer  
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 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 '%s' parameter must be formatted as a(n) string."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The 'numbers' parameter must contain unique numbers."

}
Request
{

    "serviceBusiness": "ABC Printing",

    "serviceUser": "Ted Dillon",

    "serviceUserTitle": "VP IT",

    "locationName": "AZ Fastening",

    "address1": "8050 NW 64TH ST",

    "city": "MIAMI",

    "state": "FL",

    "zip": "33166",

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

 

network

String

The number’s provisioning status.

 

Explanation

 

  • QUEUED: Our services and systems are aware that work needs to occur, but the work has not been started yet.
  • 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.

 

Allowed values: PENDING, PROVISIONED, QUEUED

 

number

Object

The number.

HTTP/1.1 200 OK

{

  "orderID": 12345,

  "batches": [

    {

      "batchID": 23456,

      "numbers": [

        {

          "callerID": null,

          "cnam": null,

          "countryCode": "1",

          "directoryListing": null,

          "e164": "+12125550001",

          "e911": "QUEUED",

          "e911Address": "e911Address": {

            "location": "AZ Fastening",

            "address1": "8050 NW 64TH ST",

            "address2": null,

            "city": "MIAMI",

            "state": "FL",

            "zip": "33166"

          },

          "network": null,

          "number": "2125550001"

        },

        {

          "callerID": null,

          "cnam": null,

          "countryCode": "1",

          "directoryListing": null,

          "e164": "+12125550002",

          "e911": "QUEUED",

          "e911Address": "e911Address": {

            "location": "AZ Fastening",

            "address1": "8050 NW 64TH ST",

            "address2": null,

            "city": "MIAMI",

            "state": "FL",

            "zip": "33166"

          },

          "network": null,

          "number": "2125550002"

        }

      ]

    }

  ]

}
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 404 Not Found

{

    "code": 404,

    "error": "Location not recognized."

}




HTTP/1.1 404 Not Found

{

    "code": 404,

    "error": "Validation does not match: %s."

}
HTTP/1.1 406 Not Acceptable

{

    "code": 406,

    "error": "Not Acceptable"

}
HTTP/1.1 409 Conflict

{

    "code": 409,

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

}




HTTP/1.1 409 Conflict

{

    "code": 409,

    "error": "One or more numbers are part of an active order: %d"

}




HTTP/1.1 409 Conflict

{

    "code": 409,

    "error": "One or more numbers do not have service: %s"

}




HTTP/1.1 409 Conflict

{

    "code": 409,

    "error": "One or more numbers are already pending disconnect: %s"

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

}