El endpoint phonelookup valida y formatea números de teléfono fijos o móviles, devolviendo información de operador, ubicación y tipo, con estado de actividad opcional.
phonelookup para validar un número de teléfono y obtener su operador, tipo y ubicación en una única respuesta JSON. ¿Busca la integración heredada basada en XML/formularios? Consulte Classic Phone API (/TEL/) →
phonelookup
Solicitud
Se admiten tanto GET como POST.
Ejemplos de código
Número de móvil válido
Envíe todos los parámetros en el cuerpo de la solicitud usando Content-Type: application/x-www-form-urlencoded. La dirección del servidor permanece en la URL.
Ejemplos de código
Número de móvil válido
Parámetros
| Parámetro | Descripción | Obl / Opc |
|---|---|---|
| Number | Número de teléfono a validar. | Obligatorio |
| Country | Código de país ISO de 3 letras. | Obligatorio |
| Licence | Su clave de licencia DQE. Póngase en contacto con soporte si todavía no tiene una. | Obligatorio |
| Format | Formato de salida deseado. Consulte la tabla de valores de formato a continuación. | Opcional |
| Activity |
Y si desea obtener la actividad del número de teléfono. |
Opcional |
| TimeOut | Tiempo máximo de consulta para la verificación, en segundos. Ejemplo: 0.5 para 500 ms. |
Opcional |
| Separator | Carácter separador utilizado en el número de teléfono formateado. Valores aceptados: - y .. Solo funciona con los formatos que utilizan espacios (1, 2, 3, 4, 6) |
Opcional |
Valores de formato
Los siguientes valores se aplican al parámetro Format tanto en solicitudes GET como POST.
| Valor | Descripción | Ejemplos (Alemania / Francia / EE. UU.) |
|---|---|---|
| 0 | Formato nacional sin espacios | 0301234567 / 0123456789 / (202)555-0123 |
| 1 | Formato nacional con agrupación de dígitos específica del país | 030 1234567 / 01 23 45 67 89 / (202) 555-0123 |
| 2 | Formato internacional con agrupación de dígitos específica del país | +49 30 1234567 / +33 1 23 45 67 89 / +1 202-555-0123 |
| 3 | Formato internacional con espacio entre el código de país y el número de abonado | +49 301234567 / +33 123456789 / +1 2025550123 |
| 4 | Formato internacional con prefijo de línea y número de abonado compacto | +49 (0)301234567 / +33 (0)123456789 / +1 (0)2025550123 |
| 5 | Formato internacional sin espacios | +49301234567 / +33123456789 / +12025550123 |
| 6 | Formato internacional con prefijo de línea y agrupación de dígitos específica del país | +49 (0) 30 1234567 / +33 (0) 1 23 45 67 89 / +1 (0) (202) 555-0123 |
| 7 | Formato nacional con agrupación de dígitos específica del país separada por puntos | 030.1234567 / 01.23.45.67.89 / (202).555-0123 |
| 8 | Formato internacional con agrupación de dígitos específica del país separada por puntos | +49.30.1234567 / +33.1.23.45.67.89 / +1.202-555-0123 |
| 9 | Formato internacional sin espacios y sin signo más inicial | 49301234567 / 33123456789 / 1202-555-0123 |
Respuesta
Si la solicitud se completa correctamente, la API devuelve un objeto JSON que contiene el número de resultados y un array de números de teléfono validados.
IdError indica el resultado detallado de la validación (0: número no válido o inexistente, 1: válido y atribuido, 2: solo sintaxis válida, no atribuido) — consulte la lista completa en la referencia de códigos de respuesta de la API.| Clave | Descripción | Tipo |
|---|---|---|
| Found | Cantidad de números de teléfono devueltos. | Integer |
| Phones | Array de resultados de validación, una entrada por cada número de teléfono enviado. | Array |
| IdError | Código de retorno de la validación. Consulte la referencia de códigos de respuesta de la API. | String |
| Ported |
Y si el número ha sido portado; vacío cuando no está disponible. |
String |
| InputNumber | Número de teléfono tal como se envió en la solicitud. | String |
| Carrier | Operador actual del número de teléfono. | String |
| Location | Ubicación geográfica asociada al número de teléfono. | String |
| OldCarrier | Operador anterior del número de teléfono, cuando se conoce. | String |
| NumberFormatted | Número de teléfono formateado según el formato seleccionado. | String |
| Type |
MOBILE o FIXED_LINE o vacío. |
String |
Ejemplo de respuesta
Número de móvil válido
Errores
| HTTP | Tipo de error | Cuerpo de la respuesta |
|---|---|---|
| 400 | Parámetro obligatorio ausente o vacío (p. ej., Number) |
{"status": 400, "message": "Missing parameters", "details": "Number", "error": "bad request"} |
| 401 | Clave de licencia no válida o no autorizada | {"status": 401, "message": "Your licence is not allowed to cover this functionnality", "details": "deded", "error": "unauthorized_client"} |
Probar la API
Haga clic en el botón de abajo para probar este endpoint en vivo desde su navegador.
Abrir consola
Ver también
Relacionada con