Mensajes

Gestiona el envío y consulta de mensajes a través de múltiples canales como SMS y Email. El sistema de mensajería de SendMe123 permite enviar mensajes individuales o por lotes con seguimiento completo del estado de entrega.

Todos los endpoints de mensajería son asíncronos: la API registra cada mensaje en la persistencia, programa la entrega en BullMQ y retorna un resumen del encolado.

Endpoints disponibles

Los endpoints de mensajes te permiten enviar comunicaciones y consultar el historial de mensajes enviados.

Método	Endpoint	Descripción
GET	/api/messages	Obtener lista paginada de mensajes
POST	/api/messages/sms/contacts	Enviar SMS a contactos específicos
POST	/api/messages/sms/all	Enviar SMS a todos los contactos
POST	/api/messages/sms/tags	Enviar SMS por etiquetas
POST	/api/messages/email/contacts	Enviar Email a contactos específicos
POST	/api/messages/email/all	Enviar Email a todos los contactos
POST	/api/messages/email/tags	Enviar Email por etiquetas

Comenzar

Explora los endpoints disponibles:

Listar Mensajes

Obtén una lista paginada de mensajes enviados con filtros.

Ver documentación →

SMS a Contactos

Envía mensajes SMS a una lista específica de números.

Ver documentación →

SMS a Todos

Envía mensajes SMS a todos los contactos en tu base de datos.

Ver documentación →

SMS por Etiquetas

Envía mensajes SMS a contactos filtrados por etiquetas.

Ver documentación →

Email a Contactos

Envía mensajes de email a direcciones específicas.

Ver documentación →

Email a Todos

Envía mensajes de email a todos los contactos.

Ver documentación →

Email por Etiquetas

Envía mensajes de email a contactos por etiquetas.

Ver documentación →

Información general

Estados de mensajes

Estado	Descripción
QUEUED	Mensaje en cola para envío
SENDING	Mensaje siendo enviado
SENT	Mensaje enviado al proveedor
DELIVERED	Mensaje entregado al destinatario
UNDELIVERED	Mensaje no pudo ser entregado
FAILED	Error en el envío
RECEIVED	Mensaje recibido por el destinatario
SCHEDULED	Mensaje programado para envío futuro
CANCELED	Mensaje cancelado
READ	Mensaje leído por el destinatario

Tipos de mensaje

Tipo	Canal	Descripción
sms	SMS	Mensaje de texto estándar
otp	SMS	Código de verificación (OTP)
flash	SMS	Mensaje flash (aparece inmediatamente)
email	Email	Correo electrónico

Tipos de contenido

• PLAIN_TEXT: Texto sin formato
• HTML: Contenido HTML para emails

Formatos soportados

• SMS: Texto plano, máximo 160 caracteres por segmento
• Email: HTML y texto plano, máximo 10MB por mensaje
• Números: Sin prefijo de país (usar campo countryCode)
• Emails: Direcciones válidas según RFC 5322

Límites

• Máximo 1000 destinatarios por petición
• Rate limiting: 100 peticiones por minuto
• SMS: Máximo 1000 caracteres (se divide en segmentos)
• Email: Máximo 10MB incluyendo archivos adjuntos

Ejemplos rápidos

Enviar SMS básico

const enviarSMS = async () => {
  try {
    const response = await axios.post('https://app.sendme123.com/api/messages/sms/contacts', {
      message: 'Hola, este es un mensaje de prueba',
      contacts: ['3001234567'],
      country: 'CO'
    }, {
      headers: {
        'Authorization': 'Bearer tu-token-aqui',
        'Content-Type': 'application/json'
      }
    });

    console.log('SMS encolado:', response.data);
    return response.data;
  } catch (error) {
    console.error('Error enviando SMS:', error.response?.data || error.message);
    throw error;
  }
};

Enviar Email básico

const enviarEmail = async () => {
  try {
    const response = await axios.post('https://app.sendme123.com/api/messages/email/contacts', {
      subject: 'Bienvenido a SendMe',
      message: '<h1>¡Bienvenido!</h1><p>Gracias por unirte a nosotros.</p>',
      contacts: ['[email protected]']
    }, {
      headers: {
        'Authorization': 'Bearer tu-token-aqui',
        'Content-Type': 'application/json'
      }
    });

    console.log('Email encolado:', response.data);
    return response.data;
  } catch (error) {
    console.error('Error enviando email:', error.response?.data || error.message);
    throw error;
  }
};