Reserve un número DID

Con las API de marcación entrante directa (DID) de IntelePeer, podrá gestionar el tráfico de voz local.

 

Busque e identifique sus números DID únicos y reténgalos con el número DID de reserva.  Al igual que un carrito de compras, poder reservar le permitirá pensar en ellos antes de que alguien más los compre.

Puntos de conexión y métodos
  • POST /_rest/v4/carrier/did/reservations
Parámetros

Encabezados

Aceptar: aplicación/json

Autorización: xxxxxxxxxxxxxxxxx

Tipo de contenido: aplicación/json

Campo

Tipo

Descripción

Country (opcional)

String

La abreviatura de país asociada con el (los) punto (s) de conexión.

 

endpoints

E.164[]

Los puntos de conexión a reservarse.

 

reservationID (opcional)

String

Un Identificador Único Universal (UUID) para asociar con los puntos de conexión reservados.

 

Request

{

    "endpoints": [

        "+12127293863",

        "1-21272"

    ]

}

Solicitud con ID de reservación explícito

{

    "endpoints": [

        "+14082737937",

        "+14082737938",

        "1-40824"

    ],

    "reservationID": "F78793B1-7E84-11E6-B908-52540029234D"

}
Ejemplos de respuesta y esquema 

Success 200

Campo

Tipo

Descripción

endpoints

 

Array

 

 

Una lista que contiene de los parámetros reservados.

endpoint

 

Numeric

La representación e.164 del punto de conexión.

 

geo

 

Object

Información geográfica sobre el punto de conexión.

 

city

 

String

La ciudad del punto de conexión.

 

country

 

String

El país del punto de conexión.

 

stateProvince

 

String

El estado/provincia del punto de conexión.

 

type

 

String

El tipo de punto de conexión. código CORTO o LARGO.

 

expirationDate

 

DateTime

La fecha ISO 8601 en que vencerá la reservación.

 

reservedDate

 

DateTime

La fecha ISO 8601 en que la reservación fue creada.

 

reservationID

 

String

El Identificador Único Universal (UUID) asociado al punto o puntos de conexión. (vea Identificador único universal)

 

HTTP/1.1 200 OK

{

"endpoints": [

      {

           "endpoint": "+14082737937",

           "geo": {

                 "city": "San Jose",

                 "country": "US",

                 "stateProvince": "CA"

           },

           "type": "LONG"

      },

      {

           "endpoint": "+14082737938",

           "geo": {

                 "city": "San Jose",

                 "country": "US",

                 "stateProvince": "CA"

           },

           "type": "LONG"

      },

      {

           "endpoint": "+14082737939",

            "geo": {

                  "city": "San Jose",

                  "country": "US",

                  "stateProvince": "CA"

            },

            "type": "LONG"

      }

      ],

  "expirationDate": "2016-11-10T19:03:54Z",

  "reservationID": "3BDBD2D9-A774-11E6-A562-52540029234D",

  "reservedDate": "2016-11-10T18:33:54Z"

}
Ejemplo y esquema de respuesta 

Error 

Nombre

Tipo

Descripción

code

Integer

Código de error

 

error String

Descripción del error

HTTP/1.1 400 Bad Request

{

"code": 400,

"error": "Number(s) not available."

}
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 'endpoints' parameter must be a number(s) in E.164 format."

}