API de Email — Validar una dirección de correo electrónico (REST)

Support DQE
Support DQE
  • Actualización

Utilice este endpoint para validar una dirección de correo electrónico y obtener información sobre su sintaxis, dominio y estado de actividad.

Documentación Restful de Email relacionada:

Solicitud GET

Endpoint

GET https://{SERVER_ADDRESS}/{VERSION}/lookupemail/?Email={EMAIL}&Licence={LICENCE_CODE}&Rectify={RECTIFY}&CheckUser={CHECK_USER}&TimeOut={TIME_OUT}

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

Parámetro Descripción Obligatorio/Opcional
Email Dirección de correo electrónico a validar. Obligatorio
Licence Código de licencia asignado a su cuenta. Obligatorio
Rectify Y para recibir una sugerencia de corrección cuando la sintaxis no sea válida o el dominio sea desconocido. Opcional
CheckUser N si no desea verificar la parte antes del signo @ (nombre de usuario). Opcional
TimeOut Tiempo máximo de consulta para la verificación, en segundos. Ejemplo: 0.5 para 500 ms. Opcional

Solicitud POST

Endpoint

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

Agregue los siguientes parámetros en el cuerpo de la solicitud usando x-www-form-urlencoded.

Parámetro Descripción Obligatorio/Opcional
Email Dirección de correo electrónico a validar. Obligatorio
Licence Código de licencia asignado a su cuenta. Obligatorio
Rectify Y para recibir una sugerencia de corrección cuando la sintaxis no sea válida o el dominio sea desconocido. Opcional
CheckUser N si no desea verificar la parte antes del signo @ (nombre de usuario). Opcional
TimeOut Tiempo máximo de consulta para la verificación, en segundos. Ejemplo: 0.5 para 500 ms. Opcional

Respuesta

Respuesta de éxito

La respuesta JSON es un diccionario que contiene el número de resultados y un array de las direcciones de correo validadas.

Clave Descripción Tipo
Found Número de direcciones de correo devueltas. INTEGER
Emails Array de resultados de validación, una entrada por cada dirección enviada. ARRAY
ActivityCode Estado de actividad de la dirección de correo. Consulte la referencia de códigos de respuesta de la API. STRING
IdError Código de retorno de validación. Consulte la referencia de códigos de respuesta de la API. STRING
Corrected 1 si se aplicó una corrección; 0 en caso contrario. INTEGER
SuggestedEmail Dirección de correo corregida, devuelta cuando Rectify=Y y se encontró una corrección. STRING
InputEmail Dirección de correo tal como se envió en la solicitud. STRING

Ejemplo:

{
  "Found": 1,
  "Emails": [
    {
      "ActivityCode": "",
      "IdError": "02",
      "Corrected": 0,
      "SuggestedEmail": "toto@gmail.com",
      "InputEmail": "toto@gmail.com"
    }
  ]
}

Respuesta de error

Tipo de error Tipo de respuesta
Parámetro obligatorio ausente o vacío 400 Bad Request
Licencia inválida o no autorizada 401 Unauthorized

Ejemplo (400):

{
  "status": 400,
  "message": "Missing parameters",
  "details": "Email",
  "error": "bad request"
}

Ejemplo (401):

{
  "status": 401,
  "message": "Your licence is not allowed to cover this functionnality",
  "details": "{WRONG LICENSE}",
  "error": "unauthorized_client"
}

Ver también

Relacionada con

¿Fue útil este artículo?

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