Documentación de la API de correo electrónico

Empiece aquí

Su primera solicitud en cuatro pasos

Configurar un buzón en el panel.

Copiar tanto apikey como el buzón apikeybox.

Enviar primero un correo electrónico de texto simple.

Agregar archivos adjuntos o incrustados imágenes solo después de que funcione la solicitud básica.

Autenticación

Mantenga las credenciales en su servidor

Los puntos finales de correo electrónico requieren la cuenta apikey y el apikeybox específico del buzón. Almacene ambas credenciales en el lado del servidor y enmascarelas en los registros de la aplicación.

CORREO

Enviar un correo electrónico

ENDPOINThttps://api.smsmobileapi.com/sendemail/

Envía correo electrónico de texto sin formato o HTML a través de un buzón configurado.

Cuándo usarlo

Úselo para correo electrónico transaccional u operativo desde su aplicación.

Parámetros

Nombre	Tipo	Requisito	Descripción
`apikey`	cadena	Requerido	Clave API de su cuenta.
`apikeybox`	cadena	Requerido	Clave API del buzón configurado.
`sender_name`	cadena	Requerido	Nombre para mostrar del remitente.
`sender_email`	correo electrónico	Requerido	Dirección de correo electrónico del remitente.
`recipient_email`	correo electrónico	Requerido	Dirección del destinatario.
`mail_subject`	cadena	Requerido	Asunto del correo electrónico.
`mail_body`	cadena	Requerido	Texto sin formato o cuerpo HTML.
`allow_self_signed`	yes \| no	Requerido	Establezca en sí solo cuando el servidor de correo configurado utilice un certificado autofirmado interno confiable.
`unsubscribe`	1	Opcional	Agrega términos para cancelar la suscripción y un enlace.
`email_cc1`	correo electrónico	Opcional	Primer destinatario CC opcional.
`email_cc2`	correo electrónico	Opcional	Segundo destinatario CC opcional.
`email_cc3`	correo electrónico	Opcional	Tercer destinatario CC opcional.
`attachmentBase64`	base64	Opcional	Contenido adjunto codificado en Base64.
`charset`	cadena	Opcional	Conjunto de caracteres; UTF-8 predeterminado.
`embeddedImage`	URL HTTPS	Opcional	Imagen para incrustar en el correo electrónico.
`embeddedImage_cid`	cadena	Opcional	ID de contenido al que se hace referencia desde el cuerpo HTML.
`format`	cadena	Opcional	Formato de respuesta solicitado.
`reply_name`	cadena	Opcional	Nombre para mostrar de respuesta.
`reply_email`	correo electrónico	Opcional	Dirección de respuesta.

Ejemplo de solicitud

rizo

curl -X POST "https://api.smsmobileapi.com/sendemail/" \
  -d "apikey=YOUR_API_KEY" \
  -d "apikeybox=YOUR_MAILBOX_KEY" \
  --data-urlencode "sender_name=Example Team" \
  -d "sender_email=team@example.com" \
  -d "recipient_email=customer@example.net" \
  --data-urlencode "mail_subject=Order confirmation" \
  --data-urlencode "mail_body=Your order has been confirmed." \
  -d "allow_self_signed=no"

¿Quiere ejecutar esta solicitud?Conecte su clave API en la parte superior de la página para desbloquear el probador interactivo.

Clave de conexión ↑

Es bueno saberlo

Prefiere POST porque los cuerpos de los correos electrónicos pueden ser largos.
Los archivos adjuntos Base64 pueden hacer que las solicitudes sean grandes; aplique límites de tamaño razonables en su aplicación.

CONSEGUIR

Recuperar correos electrónicos

ENDPOINThttps://api.smsmobileapi.com/getemail/

Recupera mensajes de una carpeta de buzón configurada.

Cuándo usarlo

Úselo para sincronizar el correo electrónico entrante en una mesa de ayuda o flujo de trabajo de la aplicación.

Parámetros

Nombre	Tipo	Requisito	Descripción
`apikey`	cadena	Requerido	Clave API de su cuenta.
`apikeybox`	cadena	Requerido	Clave API de buzón.
`mbox`	cadena	Requerido	Carpeta de buzón, por ejemplo INBOX.
`start`	entero	Requerido	Índice inicial; use 0 para la primera página.

Ejemplo de solicitud

rizo

curl "https://api.smsmobileapi.com/getemail/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&mbox=INBOX&start=0"

¿Quiere ejecutar esta solicitud?Conecte su clave API en la parte superior de la página para desbloquear el probador interactivo.

Clave de conexión ↑

Es bueno saberlo

Las respuestas incluyen asunto, remitente, destinatario, cuerpo, marca de tiempo y detalles del archivo adjunto disponibles.

CONSEGUIR

Verificar contactos cancelados

ENDPOINThttps://api.smsmobileapi.com/email/unsubscribed/

Comprueba los registros de cancelación de suscripción generados por los correos electrónicos enviados a través de la plataforma.

Cuándo usarlo

Úselo antes de enviar campañas y al sincronizar la supresión. listas.

Parámetros

Nombre	Tipo	Requisito	Descripción
`apikey`	cadena	Requerido	Clave API de su cuenta.
`apikeybox`	cadena	Requerido	Clave API de buzón.
`email`	correo electrónico	Opcional	Filtrar un contacto. Un resultado vacío significa que no se encontró ningún registro de cancelación de suscripción.

Ejemplo de solicitud

rizo

curl "https://api.smsmobileapi.com/email/unsubscribed/?apikey=YOUR_API_KEY&apikeybox=YOUR_MAILBOX_KEY&email=customer@example.net"

¿Quiere ejecutar esta solicitud?Conecte su clave API en la parte superior de la página para desbloquear el probador interactivo.

Clave de conexión ↑

Es bueno saberlo

Mantenga su propia base de datos de destinatarios sincronizada con los resultados de cancelación de suscripción.
Usted sigue siendo responsable de las reglas antispam y de privacidad aplicables.

Solución de problemas

Errores y reintentos seguros

Lea el estado HTTP y el campo de error JSON antes de volver a intentarlo. No vuelva a intentar fallas de validación o autenticación sin corregir primero la solicitud.

HTTP	Código	Qué hacer
400	`missing_parameter`	Un parámetro requerido está vacío o ausente. Consulte la tabla de parámetros del punto final.
403	`invalid_apikey`	La clave API es desconocida, ha caducado o no está autorizada para la función solicitada.
429	`too_many_requests`	Las solicitudes llegan demasiado rápido. Espere y vuelva a intentarlo con un retroceso exponencial.
500	`server_error`	El servicio no pudo completar la solicitud. Conserve la respuesta y comuníquese con el soporte si persiste.

Regla de reintentoReintente solo respuestas transitorias 429 y 5xx. Comience después de 1 segundo, luego retroceda a 2, 4 y 8 segundos.

¿Necesitar ayuda?

Traiga el contexto de la solicitud, no sus secretos.

Comparta el punto final, la marca de tiempo, el estado HTTP y la respuesta desinfectada. Nunca incluya claves API, tokens ni contenido de mensajes privados.

Comuníquese con el soporte de API →