Lista o búsqueda gratuita

Gestión de números gratuitos

Gestione sus números gratuitos. 

 

Lista o búsqueda

Use TF_Management para enumerar y buscar su inventario de números gratuitos. 

 

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

 

Puntos de conexión y métodos
  • GET: /_rest/v3/my/tf
 
Parámetros

Encabezados

  • Accept: aplicación/json
  • Authorization: xxxxxxxxxxxxxxxxx

Campo

Tipo

Descripción

Accept
String

aplicación/json

 

Authorization
String

Token de autorización (vea Autenticar)

 

Ruta

Campo

Tipo

Descripción

Label optional

String

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

 

Like optional
String

Una cadena alfanumérica para buscar.

 

  • Un valor único realizará una búsqueda “starts-with».
  • Múltiples valores realizarán una correspondencia exacta para cada nombre.

 

  •  
packageID optional
Integer

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

 

Page optional
Integer

La página de resultados a recuperar.

 

  • Por defecto: 1
  • Min: 1
  • Debe ser escalar

 

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.

 

  • Por defecto: 100
  • Max: 100
  • Min: 1
  • Debe ser escalar

 

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

 

Valor predeterminado: 100

 
Solicitud
/_rest/v3/my/tf?like=888&packageID=12345

{
    "like": "888",

    "packageID": 12345
}
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 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

 

label
String

La etiqueta del número

 

number
Numeric

El número

 

packageID
Integer

El ID de paquete del número

HTTP/1.1 200 OK

[

    {

        "countryCode": "1",

        "countryID": 255,

        "countryName": "United States",

        "e164": "+18887293863",

        "number": "8887293863",

        "packageID": 12345

    },

    {

        "countryCode": "1",

        "countryID": 255,

        "countryName": "United States",

        "e164": "+18887293864",

        "number": "8887293864",

        "packageID": 12345

    }

]
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 formatted as a(n) integer."

}




HTTP/1.1 422 Unprocessable Entity

{

    "code": 422,

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

}