Inventario de números gratuitos

Números Gratuitos (Toll-Free)

Los números de teléfono gratuitos son números de teléfono dentro de los EE.UU. que no tienen costo para la persona que llama.  

Nota: Estos números de teléfono por lo general cobran a la persona o empresa a la que se llama.

Search TF Inventory

Use Search TF Inventory para localizar números que permitan a los clientes llamarle de forma gratuita.

Puntos de conexión y métodos
GET: /_rest/v4/carrier/tf

Parámetros

Encabezados

  • Aceptar: aplicación/json       
  • Autorización: xxxxxxxxxxxxxxxxx

Campo

Tipo Descripción

Accept

String

application/json

Authorization

String

Token de autorización (vea Autenticar)

 
Ruta

Campo

Tipo

Descripción

Like (optional)

E.164

Todo o parte de un punto de conexión a buscar.

  • like o npa requerido
  • Debe ser escalar.
  • Mutuamente excluyente con secuencial.

Npa (optional)

Numeric[]

El NPA (código de área) de los puntos de conexión deseados.

  • like o npa requerido
  • Debe ser escalar.
Page (optional) Integer

La página de resultados recuperar.

Nota: Este parámetro se ignora para consultas  secuenciales.

  • Debe ser escalar.

Valor predeterminado: 1

pageSize (optional)

Integer

La cantidad de puntos de conexión a devolver por página.

  • Entre 1 y 250.
  • Debe ser escalar.

Valor predeterminado: 100

Sequential (optional)

Boolean

Si los puntos de conexión deseados deben ser secuenciales (contiguos) o no.

Las búsquedas secuenciales se limitan a un pageSize máximo de 100.

  • Requiere npa y pageSize.
  • Puede causar más que registros pageSize para retornar
  • Debe ser escalar.
  • Valores permitidos: 0,1
Ejemplo y esquema de respuesta
Solicitud Response

NPA

GET /_rest/v4/carrier/tf?npa=888

Sequential

GET /_rest/v4/carrier/tf?npa=888&sequential=1&pageSize=20

Endpoint 1-100

Nota: El símbolo más debe ser codificado por URI.

GET /_rest/v4/carrier/tf?like=%2B1800
 
Success 200

Campo

Tipo

Descripción

endpoints

Array

Una serie de puntos de conexión que coinciden con los términos de búsqueda.

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

Null

La ciudad del punto de conexión.

country

String

El país del punto de conexión (abreviatura de 2 caracteres).

stateProvince

Null

El estado/provincia del punto de conexión.

hasMore

Boolean

Si hay o no más resultados disponibles en la siguiente página.

Nota: Nota: las consultas secuenciales siempre indicarán “hasMore”: false.

 
HTTP/1.1 200 OK

{

    "endpoints": [

        {

            "endpoint": "+18887293863",

            "geo": {

                "city": null,

                "country": "US",

                "stateProvince": null

            }

        },

        {

            "endpoint": "+18887293864",

            "geo": {

                "city": null,

                "country": "US",

                "stateProvince": null

            }

        }

    ],

    "hasMore": false

}

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

{

    "code": 409,

    "error": "The following parameters are mutually exclusive: '%s', '%s'"

}
HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

    "error": "At least one of the following parameters is required: 'like', 'npa'"

}

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

}