Utilice este endpoint para validar una dirección de correo electrónico: comprobando la existencia de su dominio, su sintaxis y, opcionalmente, su estado de actividad.
Documentación relacionada de Email:
- Email introduction
- MAILSUGGEST — Email suggestion
- Email API Swagger documentation
- Email output columns
Solicitud GET
Endpoint
https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/?Email={EMAIL}&Licence={LICENCE_CODE}&Rectify={RECTIFY}&extendedsyntax={SYNTAX}&checkuser={CHECKUSER}&TimeOut={TIME}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 |
{EMAIL} |
Dirección de correo electrónico a validar. | Obligatorio | |
| Rectify | {RECTIFY} |
y para proponer una corrección del dominio cuando el dominio introducido sea desconocido; n en caso contrario. |
Opcional. Valor por defecto: n. |
| extendedsyntax | {SYNTAX} |
y para aceptar direcciones de correo electrónico con sintaxis extendida; n para limitar las comprobaciones a direcciones de correo electrónico estándar. |
Opcional. Valor por defecto: n. |
| checkuser | {CHECKUSER} |
y para verificar la parte anterior al signo @; n para verificar únicamente el dominio. |
Opcional. Valor por defecto: y. |
| TimeOut | {TIME} |
Tiempo máximo de consulta para la verificación de datos, en segundos. Ejemplo: 0.5 para 500 ms. |
Opcional |
Solicitud POST
Endpoint
https://{SERVER_ADDRESS}/DQEEMAILLOOKUP/Añada 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 |
{EMAIL} |
Dirección de correo electrónico a validar. | Obligatorio | |
| Rectify | {RECTIFY} |
y para proponer una corrección del dominio cuando el dominio introducido sea desconocido; n en caso contrario. |
Opcional. Valor por defecto: n. |
| extendedsyntax | {SYNTAX} |
y para aceptar direcciones de correo electrónico con sintaxis extendida; n para limitar las comprobaciones a direcciones de correo electrónico estándar. |
Opcional. Valor por defecto: n. |
| checkuser | {CHECKUSER} |
y para verificar la parte anterior al signo @; n para verificar únicamente el dominio. |
Opcional. Valor por defecto: y. |
| TimeOut | {TIME} |
Tiempo máximo de consulta para la verificación de datos, en segundos. Ejemplo: 0.5 para 500 ms. |
Opcional |
Respuesta
Respuesta correcta
La verificación de nivel 1 comprueba la existencia del dominio y valida la sintaxis del correo electrónico.
La respuesta JSON es un diccionario con la clave 1 que contiene los siguientes campos:
| Clave | Descripción | Tipo |
|---|---|---|
| Redressement |
1: dominio corregido; 0: no se aplicó ninguna corrección. |
INTEGER(1) |
| eMailOrigine | Dirección de correo electrónico introducida por el usuario. | STRING(255) |
| IdError | Código de retorno de la validación. Consulte la tabla de códigos IdError a continuación. | STRING(16) |
Dirección de correo electrónico corregida si Rectify=y. |
STRING(1024) |
Ejemplo:
{
"1": {
"Redressement": 0,
"eMailOrigine": "test@tesdedet.com",
"IdError": "92",
"eMail": "test@tesdedet.com"
}
}La verificación de nivel 2 comprueba adicionalmente el estado de actividad de la dirección de correo electrónico. Se puede añadir el siguiente campo:
| Clave | Descripción | Tipo |
|---|---|---|
| CodeActivite | Proporciona información sobre el estado de actividad del correo electrónico. Consulte la tabla de códigos CodeActivite a continuación. | STRING(3) |
Ejemplo con nivel 2:
{
"1": {
"Redressement": 0,
"eMailOrigine": "test@tesdedet.com",
"IdError": "92",
"eMail": "test@tesdedet.com",
"CodeActivite": "200"
}
}Códigos IdError
| Código | Descripción | Mensaje sugerido para la interfaz |
|---|---|---|
00 |
Correo electrónico válido. | Valid email |
01 |
Correo electrónico correcto pero no se pudo comprobar el nombre. | Valid email |
02 |
No se encontró la dirección de correo electrónico para este dominio. | Please check your email address |
03 |
Buzón lleno (soft bounce). | Please check your email address |
04 |
Correo electrónico vacío. | Please check your email address |
91 |
Error de sintaxis. | Please check your email address |
92 |
Dominio desconocido. | Please check your email address |
93 |
Correo electrónico o dominio en lista negra (blacklist). | Please check your email address |
94 |
Nombre de usuario no autorizado. | Please check your email address |
95 |
Dirección de correo electrónico temporal desechable. | Please check your email address |
99 |
Servicio no disponible. | Valid email |
Códigos CodeActivite
Considere M como el mes actual.
| Código | Descripción |
|---|---|
100 |
El correo electrónico se entregó una vez. |
200 |
El correo electrónico es válido. |
201 |
El correo electrónico estuvo activo el mes pasado. |
202 |
El correo electrónico estuvo activo entre M-1 y M-2. |
203 |
El correo electrónico estuvo activo entre M-2 y M-3. |
204 |
El correo electrónico estuvo activo entre M-3 y M-4. |
206 |
El correo electrónico estuvo activo entre M-4 y M-6. |
209 |
El correo electrónico estuvo activo entre M-6 y M-9. |
212 |
El correo electrónico estuvo activo entre M-9 y M-12. |
300 |
Correo electrónico inactivo. |
Respuesta de error
| Tipo de error | Tipo de respuesta |
|---|---|
Parámetro Licence ausente |
** LICENCE KO ** |
Parámetro Licence vacío |
** LICENCE KO ** |
| Número de licencia incorrecto | unauthorized_client |
Parámetro Email ausente o vacío |
IdError = 04 |
| Error tipográfico en un parámetro | IdError = 04 |
Ver también
Relacionada con