Phone API — Validar un número de teléfono (REST)

Support DQE
Support DQE
  • Actualización

Utilice este endpoint para validar y formatear números de teléfono fijo o móvil mediante el endpoint /phonelookup.

Documentación relacionada de Phone:

Solicitud GET

Endpoint

GET https://{SERVER_ADDRESS}/{VERSION}/phonelookup?country={COUNTRY_CODE}&phone={PHONE}&format={FORMAT}&status={STATUS}&timeout={TIMEOUT}&separator={SEPARATOR}

Reemplace los valores entre llaves con su propia información.

Parámetro Descripción Obligatorio/Opcional
country Código de país ISO de 3 letras. Obligatorio
phone Número de teléfono a validar. Obligatorio
format Formato de salida deseado. Consulte la tabla de valores de formato más abajo. Opcional
status Establézcalo en true para habilitar la verificación de estado adicional cuando esté disponible. Opcional
timeout Tiempo máximo de consulta para la verificación, en segundos. Opcional
separator Carácter separador utilizado en el número de teléfono formateado. Valores aceptados: - y .. Solo funciona en formatos que usan espacios (1, 2, 3, 4, 6) Opcional

Solicitud POST

Endpoint

POST https://{SERVER_ADDRESS}/{VERSION}/phonelookup

Envíe los siguientes parámetros en el cuerpo de la solicitud usando JSON.

Parámetro Descripción Obligatorio/Opcional
country Código de país ISO de 3 letras. Obligatorio
phone Número de teléfono a validar. Obligatorio
format Formato de salida deseado. Consulte la tabla de valores de formato más abajo. Opcional
status Establézcalo en true para habilitar la verificación de estado adicional cuando esté disponible. Opcional
timeout Tiempo máximo de consulta para la verificación, en segundos. Opcional
separator Carácter separador utilizado en el número de teléfono formateado. Valores aceptados: - y .. Solo funciona en formatos que usan espacios (1, 2, 3, 4, 6) Opcional

Ejemplo

{
  "country": "FRA",
  "phone": "0611223344",
  "format": 2,
  "status": true,
  "timeout": 0.5,
  "separator": "."
}

Valores de formato

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

Respuesta correcta

Clave Descripción Tipo
IdError 2: sintaxis válida; 1: válido y atribuido; 0: número inválido o inexistente. INTEGER
Error Mensaje de error asociado al resultado de la validación. STRING
Formatted Número de teléfono formateado según el formato seleccionado. STRING
International Número de teléfono en formato internacional. STRING
National Número de teléfono en formato nacional. STRING
E164 Número de teléfono en formato E.164. STRING
Country Código de país ISO de 3 letras. STRING
CountryCode Código de marcación internacional. STRING
NationalNumber Número nacional significativo. STRING
Type MOBILE o FIXED_LINE o FIXED_LINE_OR_MOBILE o vacío STRING
Operator Operador de telecomunicaciones cuando está disponible. STRING
IsValid Indica si el número de teléfono es válido. BOOLEAN
IsMobile Indica si el número es un número móvil. BOOLEAN
Status Estado devuelto por la verificación de estado opcional. STRING

Ejemplo

{
  "IdError": 0,
  "Error": "",
  "Formatted": "+33 6 11 22 33 44",
  "International": "+33611223344",
  "National": "06 11 22 33 44",
  "E164": "+33611223344",
  "Country": "FRA",
  "CountryCode": "33",
  "NationalNumber": "611223344",
  "Type": "Mobile",
  "Operator": "Orange",
  "IsValid": true,
  "IsMobile": true,
  "Status": "ACTIVE"
}

Respuesta de error

Tipo de error Tipo de respuesta
Autenticación faltante o no válida 401 Unauthorized
Falta el parámetro phone 400 Bad Request
Número de teléfono no válido Respuesta de error de validación

Ver también

Relacionada con

¿Fue útil este artículo?

Usuarios a los que les pareció útil: 0 de 0