Add or Change CNAM
Manage the ability to display a caller’s name with the CNAM service.
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 (for more information, see Atmosphere® API Authentication) |
| Content-Type | STRING | application/json |
Path
| Field | Type | Description |
|---|---|---|
| numbers | ARRAY |
An array of reserve numbers on which to operate. Each item is in 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
Copy
{
"cnam": "xxxxxx",
"numbers": [
{
"countryCode": "1",
"number": "2125550001"
},
{
"countryCode": "1",
"number": "2125550002"
}
]
}Response Example and Schema
Success 200
| Field | Type |
|---|---|
| OrderID | INTEGER |
Success Response
Copy
HTTP/1.1 200 OK
{
"OrderID": 31542
}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 406 Response
Copy
HTTP/1.1 406 Not Acceptable
{
"code": 406,
"error": "Not Acceptable"
}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) array."
}
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 'numbers' parameter must contain unique numbers."
}
Copy
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'cnam' parameter must consist of letters, numbers, or spaces."
}
Copy
HTTP/1.1 422 Unprocessable Entity
{
"code": 422,
"error": "The 'cnam' parameter must be 15 characters or less."
}