Retire E911

Retire E911

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

 
Puntos de conexión y métodos

• BORRE: /_rest/v3/my/did/e911

 
Parámetros

Encabezados

• Aceptar: application/json

• Autorización: xxxxxxxxxxxxxxxxx

• Tipo de contenido: application/json

Encabezados

Campo

Tipo

Descripción

Aceptar

Cadena de caracteres

aplicación/json

Autorización


Cadena de caracteres

Token de autorización (ver Autenticación)

Tipo de contenido
Cadena de caracteres

aplicación/json

 
Parámetros

Campo

Tipo

Descripción

Correo electrónico 
opcional
Cadena de caracteres

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

 

Notas opcional
Cadena de caracteres

Notas sobre el cumplimiento de esta solicitud.

 

números
Serie

Una serie de números para retirar el servicio E911.

 

• Cada elemento se encuentra de la siguiente manera:

 

{

    "countryCode": "1",
    "number": "1112223456"
}

ID de referencia
opcional
Cadena de caracteres

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

 

Negocio del servicio
Cadena de caracteres

La compañía que solicita el servicio E911.

 

Usuario del servicio
Cadena de caracteres

La persona que solicita el servicio E911.

 

Cargo del usuario 
del servicio
Cadena de caracteres

El cargo de la persona que solicita el servicio E911.

 
Solicitud
{

    "serviceBusiness": "ABC Printing",

    "serviceUser": "Ted Dillon",

    "serviceUserTitle": "VP IT",

    "numbers": [

        {

            "countryCode": "1",

            "number": "2125550001"

        },

        {

            "countryCode": "1",

            "number": "2125550002"

        }

    ]

}
Ejemplo y esquema de respuesta

Success 200

Campo

Tipo

Descripción

solicitud
Objeto

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

 

ID de la solicitud
Número entero

El ID general asociado con esta solicitud.

 

lotes
Serie

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

 

ID del lote
Número entero

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

 

números
Serie

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

 

Identificador de 
llamadas opcional
Cadena de caracteres

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 opcional
Cadena de caracteres

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

 

Código de país
Numérico

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

Lista de directorio 
opcional
Cadena de caracteres

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
Numérico

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

 

E911 opcional
Cadena de caracteres

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

 

Dirección e911 
opcional
Objeto

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

 

nombre
Cadena de caracteres

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

 

dirección1
Cadena de caracteres

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

 

dirección2
Cadena de caracteres

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

 

ciudad
Cadena de caracteres

La ciudad de la dirección de registro 911.

 

estado
Cadena de caracteres

El estado de la dirección de registro 911.

red
Cadena de caracteres

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

 

número
Objeto

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": null,

          "network": null,

          "number": "2125550001"

        },

        {

          "callerID": null,

          "cnam": null,

          "countryCode": "1",

          "directoryListing": null,

          "e164": "+12125550002",

          "e911": "QUEUED",

          "e911Address": null,

          "network": null,

          "number": "2125550002"

        }

      ]

    }

  ]

}
Error

Nombre

Tipo Descripción
Código

Número entero

Código de error

error
Cadena de caracteres

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"

}

"The specified order must be completed or cancelled before trying the same request."

HTTP/1.1 409 Conflict

{

    "code": 409,

    "error": "A conflicting order is in progress: %d"

}




"E911 service cannot be removed from one or more numbers."

HTTP/1.1 409 Conflict

{

    "code": 409,

    "error": "One or more numbers ineligible."

}




"E911 service cannot be removed from the specified numbers because they do not have E911 service."

HTTP/1.1 409 Conflict

{

    "code": 409,

    "error": "Numbers do not have service: %s"

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

}