Comprar números DID

Después de encontrar, o encontrar y reservar, sus números DID únicos, use Purchase DID Numbers para comprarlos. 

Puntos de conexión y métodos
POST /_rest/v3/my/did/orders

Parámetros

Encabezados

Aceptar: aplicación/json

Autorización: xxxxxxxxxxxxxxxxx

Tipo de contenido: aplicación/json

Campo

Tipo

Descripción

Aceptar
String

application/json

Autorización


String

Token de autorización (vea Autenticar)

Tipo de contenido
String

application/json

 
Ruta

Campo

Tipo

Descripción

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.
npa
String

El NPA desde el cual ordenar los números.

  • Mutuamente excluyente con números, reservas y estado
numbers
Array

Una serie de números reservados para ordenar (vea Buscar y Reservar)

  • Mutuamente excluyente con npa, cantidad, reservas y estado
  • Cada elemento se encuentra de la siguiente manera:
{
    "countryCode": "1",
    "number": "1112223456"
}

packageID

Integer

El packageID target para el que hay que pedir los números.

quantity
Integer

La cantidad de números a ordenar.

  • Mutuamente excluyente con números y reservas
referenceID
optional

String

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

Reservations optional
String[]

Una serie de IDs de reservación (vea Buscar y Reservar)

  • Mutuamente excluyente con npa, números, cantidad y estado
Sequential optional
Boolean

True para requerir que todos los números de este orden estén en secuencia. Pueden aplicar cargos adicionales.

Valor predeterminado: false

state
String

Abreviatura de estado de dos dígitos a partir de la cual se ordenan los números.

  • Mutuamente excluyente con npa y números.
serviceName

String

El nombre de la ubicación del servicio.

serviceAddress
Object

La dirección de servicio.

address1


String

La primera línea de la dirección del servicio.

address2


String

La segunda línea de la dirección del servicio.

city
String

La ciudad de la dirección del servicio.

state

String

El estado de la dirección del servicio.

zip


String

El código postal de la dirección del servicio.

billingName
optional
String

El nombre de la ubicación de facturación.

Nota: Si se proporciona alguno de los parámetros de billingAddress*, también se requieren los siguientes parámetros:

billingName billingAddress.address1billingAddress.city billingAddress.state billingAddress.zip

billingAddress
optional
Object

Dirección de facturación: Si se omite, se utilizará serviceAddress en lugar de billingAddress.

Address1
optional
String

La primera línea de la dirección de facturación.

Nota: Si se proporciona alguno de los parámetros de billingAddress*, también se requieren los siguientes parámetros:

billingName billingAddress.address1billingAddress.city billingAddress.state billingAddress.zip

Address2
optional
String

La segunda línea de la dirección de facturación.

Nota: Si se proporciona alguno de los parámetros de billingAddress*, también se requieren los siguientes parámetros:

billingName billingAddress.address1billingAddress.city billingAddress.state billingAddress.zip

City
optional
String

La ciudad de la dirección de facturación.

Nota: Si se proporciona alguno de los parámetros de billingAddress*, también se requieren los siguientes parámetros:

billingName billingAddress.address1billingAddress.city billingAddress.state billingAddress.zip

State 
optional
String

El estado de la dirección de facturación.

Nota: Si se proporciona alguno de los parámetros de billingAddress*, también se requieren los siguientes parámetros:

billingName billingAddress.address1billingAddress.city billingAddress.state billingAddress.zip

Zip
optional
String

El código postal de la dirección de facturación.

Nota: Si se proporciona alguno de los parámetros de billingAddress*, también se requieren los siguientes parámetros:

billingName billingAddress.address1billingAddress.city billingAddress.state billingAddress.zip

POST /_rest/v3/my/did/orders

{

  "npa": "619",

  "packageID": 1234567,

  "serviceName": "ABC Signs",

  "serviceAddress": {

    "address1": "1234 Main St",

    "city": "Springfield",

    "state": "IL",

    "zip": "62701"

  }

}
POST /_rest/v3/my/did/orders

{

  "numbers": [

    {

      "countryCode": "1",

      "number": "2125559998"

    },

    {

      "countryCode": "1",

      "number": "2125559999"

    }

  ],

  "packageID": 1234567,

  "billingName": "ABC Signs",

  "billingAddress": {

    "address1": "1234 Main St",

    "city": "Springfield",

    "state": "IL",

    "zip": "62701"

  },

  "serviceName": "Signs 'R' Us",

  "serviceAddress": {

    "address1": "4475 2nd Ave",

    "city": "Aurora",

    "state": "CO",

    "zip": "80013"

  }

}
POST /_rest/v3/my/did/orders

{

  "reservations": [

    "ae62b6bd-cf20-11e7-b207-525400807a6d",

    "baa7fe27-cf20-11e7-b207-525400807a6d",

    "c5c7b9d6-cf20-11e7-b207-525400807a6d"

  ],

  "packageID": 1234567,

  "serviceName": "Diaspora Direct",

  "serviceAddress": {

    "address1": "10715 Beaufort St",

    "city": "Denver",

    "state": "CO",

    "zip": "80244"

  }

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

  • 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 402 Payment Required

{
    "code": 402,

    "error": "Order blocked; trial limit realized.  Limit: %d seats."
}
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 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(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."
}