Phone API — Validar y estandarizar un número de teléfono

Support DQE
Support DQE
  • Actualización

Utilice este endpoint para validar y formatear un número de teléfono mediante el endpoint /TEL/.

Documentación relacionada de Phone:

Solicitud GET

Endpoint

https://{SERVER_ADDRESS}/TEL/?Pays={COUNTRY_CODE}&Tel={TEL}&Format={FORMAT}&Status=Y&TimeOut={TIME}&Separator={SYMBOL}&Licence={LICENCE_CODE}

Reemplace los valores entre llaves por su propia información:

Parámetro Valor Descripción Obligatorio/Opcional
SERVER_ADDRESS {SERVER_ADDRESS} Dirección del servidor DQE que procesará los datos. Obligatorio
Licence {LICENCE_CODE} Código de licencia asignado a su cuenta. Obligatorio
Pays {COUNTRY_CODE} Código de país ISO de 3 letras. Obligatorio
Tel {TEL} Número de teléfono a validar. Obligatorio
Format {FORMAT} Nivel de formato deseado. Consulte la tabla de valores de formato a continuación. Opcional
Status Y Activa la verificación de nivel 2 para números de teléfono móviles franceses y devuelve los campos adicionales Status y LabelStatus. Opcional
TimeOut {TIME} Tiempo máximo de consulta para la verificación, en segundos. Ejemplo: 0.5 para 500 ms. Opcional
Separator {SYMBOL} 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

Solicitud POST

Endpoint

https://{SERVER_ADDRESS}/TEL/

Envíe los siguientes parámetros en el cuerpo de la solicitud utilizando x-www-form-urlencoded.

Parámetro Valor Descripción Obligatorio/Opcional
Licence {LICENCE_CODE} Código de licencia asignado a su cuenta. Obligatorio
Pays {COUNTRY_CODE} Código de país ISO de 3 letras. Obligatorio
Tel {TEL} Número de teléfono a validar. Obligatorio
Format {FORMAT} Nivel de formato deseado. Consulte la tabla de valores de formato a continuación. Opcional
Status Y Activa la verificación de nivel 2 para números de teléfono móviles franceses y devuelve los campos adicionales Status y LabelStatus. Opcional
TimeOut {TIME} Tiempo máximo de consulta para la verificación, en segundos. Ejemplo: 0.5 para 500 ms. Opcional
Separator {SYMBOL} 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 red nacional 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 red nacional 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

Verificación de nivel 1

La verificación de nivel 1 valida la existencia y el formato del número de teléfono.

La respuesta JSON contiene una clave 1 con los siguientes campos:

Clave Descripción Tipo
TelOrigine Número de teléfono analizado. STRING
Geolocation Ubicación donde el número fue asignado inicialmente. STRING
Tel Número de teléfono formateado según el formato seleccionado. STRING
Ported Vacío en la verificación de nivel 1. STRING
Operator Operador al que se asignó inicialmente el número de teléfono. STRING
IdError 2: sintaxis válida; 1: válido y atribuido; 0: número no válido o inexistente. INTEGER
OldOperator Operador original del número de teléfono. STRING
Type MOBILE o FIXED_LINE o FIXED_LINE_OR_MOBILE o vacío STRING

Ejemplo:

{
  "1": {
    "TelOrigine": "+12XXXXXXXXX",
    "Geolocation": "UNITED STATES OF AMERICA",
    "Tel": "+12345678910",
    "Ported": "",
    "Operator": "FIRST COMMUNICATIONS",
    "IdError": 1,
    "OldOperator": "FIRST COMMUNICATIONS",
    "Type": "MOBILE"
  }
}

Verificación de nivel 2

Advertencia: ya no se proporciona la información de alcanzabilidad (reachable). Esta variable se conserva por motivos históricos.

La verificación de nivel 2 proporciona el estado de actividad e información del operador. Actívela pasando Status=Y en la solicitud. La respuesta JSON contiene los siguientes campos adicionales (o actualizados):

Clave Descripción Tipo
Ported Y si el número ha sido portado, N en caso contrario. STRING(1)
Operator Operador actual del número de teléfono. STRING
OldOperator Operador anterior cuando el número ha sido portado. STRING
LabelStatus Reachable o No reachable information (solo móvil). STRING
Status 0: reachable; 1: no reachable information. STRING

Ejemplo con Status=Y:

{
  "1": {
    "TelOrigine": "0XXXXXXXXX",
    "Geolocation": "FRANCE",
    "LabelStatus": "Not Reachable",
    "Tel": "0XXXXXXXXX",
    "Ported": "N",
    "Status": "1",
    "Operator": "ORANGE",
    "IdError": 1,
    "OldOperator": "",
    "Type": "MOBILE"
  }
}

Respuesta de error

Tipo de error Tipo de respuesta
Parámetro Licence ausente Error Licence Down en la respuesta JSON.
Parámetro Licence vacío Error Licence Down en la respuesta JSON.
Número de licencia incorrecto Error Licence Down en la respuesta JSON.
Parámetro Tel ausente o vacío 400 Bad Request
Error tipográfico en un parámetro 400 Bad Request

Ejemplo de error de licencia:

{
  "1": {
    "TelOrigine": "06XXXXXXXX",
    "Geolocation": "",
    "Tel": "",
    "Ported": "",
    "Operator": "",
    "IdError": 0,
    "OldOperator": "",
    "Error": "Licence Down"
  }
}

Ver también

Relacionada con

¿Fue útil este artículo?

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