Retire CNAM

Retire CNAM

Retire el servicio CNAM de una lista de números.

 
Puntos de conexión y métodos
  • BORRE:  /_rest/v3/my/did/cnam

 

Parámetros

Encabezados

  • Accept: aplicación/json
  • Authorization: xxxxxxxxxxxxxxxxx
  • Content-Type: aplicación/json

 

Header

Campo

Tipo

Descripción

Accept
String

aplicación/json

 

Authorization
String

Token de autorización (vea Autenticar)

 

Content-Type
String

aplicación/json

Parámetro

Campo

Tipo

Descripción

numbers
Array

Una serie de números de reserva sobre los cuales operar. 

 

Cada elemento se encuentra de la siguiente manera:

 

{

    "countryCode": "1",

    "number": "2125550001"

}

Email optional
String

Una dirección de correo electrónico para notificar sobre los cambios en este estado de la solicitud.

 

Notes optional


String

Notas sobre el cumplimiento de esta solicitud.

 

referenceID optional
String

Una cadena de caracteres no vacía que indica su ID o código de referencia.

 

Solicitud
{

    "numbers": [

        {

            "countryCode": "1",

            "number": "2125550001"

        },

        {

            "countryCode": "1",

            "number": "2125550002"

        }

    ]

}
Ejemplo y esquema de respuesta

Success 200

 

Campo

Tipo

Descripción

OrderID
Integer  
HTTP/1.1 200 OK

{

    "OrderID": 31542

}
Error

Nombre

Tipo Descripción
code

Integer

Código de error

error
String

Descripción del error

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

}
Solicitud
{

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

        }

    ]

}
Ejemplo y esquema de respuesta

Success 200

 

Campo

Tipo

Descripción

order
Object

Un objeto complejo que identifica detalles específicos de lote y de suministro de números.

 

orderID
Integer

El ID general asociado con esta solicitud.

 

batches
Array

Una serie de objetos de “lote” con detalles relativos al suministro de números.

 

batchID
Integer

El ID asociado con esta porción de la solicitud (lote).

 

numbers
Array

Una serie de objetos que especifican los números y los atributos de suministro relacionados con este lote en particular.

 

callerID optional
String

El estatus de suministro del servicio de Búsqueda del Identificador de Llamadas, si es solicitado/aplicable (consulte la red para las descripciones de valor).

 

Valores permitidos: PENDIENTE, SUMINISTRADO, EN COLA

 

Cnam optional
String

El estatus de suministro del servicio de Registro del Identificador de Llamadas (CNAM), si es solicitado/aplicable (consulte la red para las descripciones de valor).

 

Valores permitidos: PENDIENTE, SUMINISTRADO, EN COLA

 

countryCode
Numeric

El código de país del número

 

directoryListing
optional
String

El estatus de suministro del servicio de Lista de directorios, si es solicitado/aplicable (consulte la red para las descripciones de valor).

 

Valores permitidos: PENDIENTE, SUMINISTRADO, EN COLA

 

e164
Numeric

La representación e.164 del número.

 

E911 optional
String

El estatus de suministro del servicio 911, si es solicitado/aplicable (consulte la red para las descripciones de valor).

 

Valores permitidos: PENDIENTE, SUMINISTRADO, EN COLA

 

e911Address optional
Object

Si la solicitud está añadiendo o cambiando el servicio 911, esta es la dirección asociada.

 

name
string

El nombre/etiqueta de la dirección de registro 911.

 

address1
string

La primera línea de la dirección de registro 911.

 

address2
string

La segunda línea de la dirección de registro 911.

 

city
string

La ciudad de la dirección de registro 911.

 

state
string

El estado de la dirección de registro 911.

 

network
String

El estatus del suministro de números.

 

Explicación:

 

  • EN COLA: Nuestros servicios y sistemas entienden que se requiere ejecutar el trabajo, pero el trabajo aún no ha sido iniciado.
  • PENDIENTE: Nuestros servicios y sistemas han iniciado el trabajo requerido para proveer este servicio.
  • SUMINISTRADO: Nuestros servicios y sistemas han completado el trabajo requerido y el servicio está activo actualmente, a menos que sea alterado luego por una solicitud posterior.

 

Valores permitidos: PENDIENTE, SUMINISTRADO, EN COLA

 

number
Object

El número

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

Nombre

Tipo

Descripción

code
Integer

Código de error

 

error
String

Descripción del error

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

}