Lista o búsqueda DID

Administración de la marcación entrante directa (DID)

Administre sus números DID.  

 
Lista o búsqueda

Use DID_Management  para enumerar y buscar su inventario de números DID. 

 

Nota: Cuando haya más registros disponibles en la página siguiente, la API devolverá registros pageSize + 1 .

 

Puntos de conexión y métodos

  • GET: /_rest/v3/my/did

 

Parámetros

Encabezados

  • Accept: application/json
  • Authorization: xxxxxxxxxxxxxxxxx

Campo

Tipo Descripción
Accept

 

String

application/json

Authorization

 

String

Token de autorización (vea Autenticar)

Ruta

   
Campo Tipo

Descripción

countryCode optional

 

Numeric[]

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

 

hasE911 optional

 

Boolean

El estado del E911 del número o números deseados.

– Debe ser escalar.

 

Like optional

 

String

Una cadena alfanumérica para buscar.

 

   

·       – Los caracteres alfabéticos se traducirán a números, así: 2 = ABC, 3 = DEF, 4 = GHI, 5 = JKL, 6 = MNO, 7 = PQRS, 8 = TUV, 9 = WXYZ

·       – Debe ser escalar.

 

Label optional

 

String[]

La etiqueta del número o números deseados.

 

Npa optional

 

Numeric[]

El NPA (código de área) de los números deseados.

 

Nxx optional

 

Numeric[]

El NXX (prefijo local) del número o números deseados.

 

packageID optional

 

Integer[]

El ID de paquete del número o números deseados.

 

Page optional

 

Integer

La página de resultados recuperar.

 

   

Nota: Cuando haya más registros disponibles en la página siguiente, esta API devolverá registros pageSize + 1.

 

Valor predeterminado: 1

 

pageSize optional

 

Integer

Número máximo de resultados a ser devueltos por página. Max: 100

 

Nota: Cuando haya más registros disponibles en la página siguiente, esta API devolverá registros pageSize + 1 .

 

Valor predeterminado: 100

 

rateCenter optional

 

String[]

El centro de tasa del número(s) deseado(s).

 

State optional

 

String[]

El estado de los números deseados (vea ISO 3166-2:US)

Búsqueda E911

GET /_rest/v3/my/did?hasE911=true
 

Búsqueda de múltiples NPAs

GET /_rest/v3/my/did?npa[]=303&npa[]=303
 

Búsqueda de NPA-Nxx

GET /_rest/v3/my/did?npa=303&nxx=729

Ejemplo y esquema de respuesta Success 200

Campo 

Tipo Descripción
countryCode

 

Numeric

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

 

countryID

 

Integer

El ID interno de país del número.

 

countryName

 

String

El nombre de país del número.

 

e164

 

Numeric

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

 

e911Address optional

 

Object

Si el número tiene servicio E911, la dirección registrada para el servicio E911.

 

address1

 

string

La primera línea de la dirección E911 registrada.

 

address2

 

string

La segunda línea de la dirección E911 registrada.

 

city

 

string

La ciudad de la dirección E911 registrada.

 

name

 

string

El nombre/etiqueta de la dirección E911 registrada.

 

state

 

string

El estado de la dirección E911 registrada.

 

hasE911

 

Boolean

El estado E911 del número.

 

label

 

String

La etiqueta del número.

npa

 

Numeric

El NPA (código de área) del número.

 

nxx

 

Numeric

El NXX (prefijo local) del número.

 

number

 

Numeric

El número

 

packageID

 

Integer

El ID de paquete del número.

 

rateCenter

 

String

El centro de tasa del número.

 

state

 

String

El estado del número (vea ISO 3166-2:US).

   
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
     
   

 

HTTP/1.1 200 OK

[

    {

        "countryCode": "1",

        "countryID": 255,

        "countryName": "United States",

        "e164": "+13037293863",

        "hasE911": false,

        "e911Address": null,

        "label": "no E911",

        "npa": "303",

        "number": "3037293863",

        "nxx": "729",

        "packageID": 12345,

        "rateCenter": "DENVER",

        "state": "CO"

    },

    {

        "countryCode": "1",

        "countryID": 255,

        "countryName": "United States",

        "e164": "+13037293864",

        "hasE911": false,

        "e911Address": {

            "name": "Home Office",

            "address1": "5975 S QUEBEC ST",

            "address2": "",

            "city": "CENTENNIAL",

            "state": "CO",

            "zip": "80111"

        }

        "label": "",

        "npa": "303",

        "number": "3037293864",

        "nxx": "729",

        "packageID": 12345,

        "rateCenter": "DENVER",

        "state": "CO"

    }

]
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 must be scalar."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be formatted as a(n) boolean."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be formatted as a(n) integer."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be formatted as a(n) numeric."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "The '%s' parameter must be formatted as a non-empty string."

}