Desconectar números DID

Desconectar números DID

Use Disconnect DID para desconectar un número de un cliente.  Esto lo devuelve al inventario de la operadora pasado cualquier período de cuarentena applicable.

 
Puntos de conexión y métodos
  • POST: /_rest/v3/my/did/disconnect
 
Parámetros

Encabezados

  • Aceptar: aplicación/json
  • Autorización: xxxxxxxxxxxxxxxxx
  • Tipo de contenido: aplicación/json

Campo 

Tipo 

Descripción

Accept
String

application/json

Authorization


String

Token de autorización (ver Autenticar)

Content-Type
String

application/json

Ruta

Campo

Type 

Description

numbers
Array

Una serie de números sobre los cuales operar. 

Cada elemento se encuentra de la siguiente manera:

{
    "countryCode": "1",
    "number": "1112223456"
}
 
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 el ID de su cliente o referencia externa.

Solicitud
POST /_rest/v3/my/did/disconnect

{

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

zip

string

El código postal de la dirección de registro del 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": "QUEUED",

          "cnam": null,

          "countryCode": "1",

          "directoryListing": null,

          "e164": "+14084744638",

          "e911": "QUEUED",

          "e911Address": null,

          "network": "PENDING",

          "number": "4084744638"

        },

        {

          "callerID": "QUEUED",
      
	  "cnam": null,

          "countryCode": "1",

          "directoryListing": null,

          "e164": "+14084744638",

          "e911": "QUEUED",

          "e911Address": null,

          "network": "PENDING",

          "number": "4084744638"

        }

      ]

    }

  ]

}

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 409 Conflict

{

    "code": 409,

    "error": "One or more numbers is already pending disconnect."

}




HTTP/1.1 409 Conflict

{

    "code": 409,

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

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

}