Wialon para desarrolladores Manual de usuario Documentación de API account check_smtp_settings

check_smtp_settings

Para validar la configuración del servidor SMTP antes de aplicarla a un plan de facturación, utilice el método account/check_smtp_settings.

Solo los usuarios de cuentas de nivel superior pueden utilizar este método. Los subusuarios reciben un error.

Endpoint

Copied!
svc=account/check_smtp_settings&params={
    "send_from": <text>,
    "send_to": <text>,
    "smtp_host": <text>,
    "smtp_port": <uint>,
    "smtp_login": <text>,
    "smtp_password": <text>,
    "subject": <text>,
    "body": <text>
}

Parámetros

La solicitud debe contener los siguientes parámetros:

Parámetro Descripción
send_from Dirección de email del remitente.
send_to Dirección de email del destinatario del mensaje de prueba.
smtp_host Dirección del servidor SMTP, incluido el protocolo (por ejemplo, smtps://smtp.gmail.com o smtp://smtp.example.com).
smtp_port Número de puerto del servidor SMTP (por ejemplo, 465 para SMTPS, 587 para SMTP con STARTTLS).
smtp_login Nombre de usuario para la autenticación SMTP.
smtp_password Contraseña para la autenticación SMTP. En lugar de este parámetro, puede utilizar plan con el nombre del plan de facturación. Es obligatorio indicar uno de estos dos parámetros.
plan Nombre del plan de facturación del que se obtiene la contraseña SMTP guardada. En lugar de este parámetro, puede utilizar el parámetro smtp_password. Si se indican ambos parámetros, se utiliza plan.
subject Asunto del email de prueba.
body Texto del cuerpo del email de prueba.

Ejemplos

A continuación se muestran ejemplos de solicitudes account/check_smtp_settings.

Solicitud con contraseña

Copied!
svc=account/check_smtp_settings&params={
    "send_from": "notifications@example.com",
    "send_to": "admin@example.com",
    "smtp_host": "smtps://smtp.gmail.com",
    "smtp_port": 465,
    "smtp_login": "notifications@example.com",
    "smtp_password": "your_app_password",
    "subject": "Test SMTP Connection",
    "body": "This is a test email to validate SMTP settings."
}

Solicitud con plan de facturación

Copied!
svc=account/check_smtp_settings&params={
    "send_from": "notifications@example.com",
    "send_to": "admin@example.com",
    "smtp_host": "smtps://smtp.gmail.com",
    "smtp_port": 465, 
    "smtp_login": "notifications@example.com",
    "plan": "my_billing_plan",
    "subject": "Test SMTP Connection",
    "body": "This is a test email to validate SMTP settings." 
    }

Respuesta

Si la solicitud se completa correctamente y se envía el email de prueba, la respuesta devuelve el código 250 en el campo error:

Copied!
{
    "error": 250
}

Si la solicitud falla, se devuelve un código de error.

Códigos de error

Código de error Descripción
600 Error general de validación o de configuración. Este código puede indicar una de las siguientes situaciones:
  • Parámetros de entrada no válidos
  • No se indicó ni la contraseña ni el plan de facturación
  • No se pudo obtener el plugin de cuentas de facturación
  • No se pudieron obtener los planes de las subcuentas
  • No se encontró el plan de facturación indicado
  • No se pudo obtener el plugin de configuración de email
  • No se pudo obtener el servicio de email
  • No se pudo crear el email
800 El usuario actual no es un usuario de una cuenta de nivel superior o no ha iniciado sesión.
6 No se pudo resolver el host del servidor SMTP.
28 Tiempo de espera de conexión agotado. Puede ocurrir si se indica un puerto incorrecto.
56 No se pudieron recibir datos del servidor. Puede ocurrir al intentar conectarse a un servidor SMTPS mediante el protocolo SMTP.
535 Credenciales SMTP no válidas (nombre de usuario o contraseña).
555 Formato incorrecto de la dirección de email o carácter no reconocido en los campos send_from o send_to.

Si nota un error en el texto, por favor resáltelo y presione Ctrl+Intro.