Add or Change CNAM

Manage CNAM

Manage the ability to display a caller’s name with the CNAM service.  

 
Add or Change CNAM

Use Add CNAM to join, or change,  the service to a list of numbers.

 

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

 

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

numbers

Array

An array of reserve numbers on which to operate. 

Each item is of the following form:

{

    "countryCode": "1",

    "number": "2125550001"

}

cnam

String

The cnam label to see. Only 15 letters, numbers, or spaces allowed.

 

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

{

    "cnam": "xxxxxx",

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

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The 'cnam' parameter must consist of letters, numbers, or spaces."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The 'cnam' parameter must be 15 characters or less."

}