cs-notifications-papi icon

cs-notifications-papi

0.0.x
(0 reviews)
Este servicio es una API diseñada para el procesamiento y envío de mensajes SMS y correos electrónicos. Permite a los usuarios enviar correos, rastrear la entrega de notificaciones por email y enviar mensajes SMS, incluyendo a través de Twilio.

📬 cs-notifications-papi

Esta API permite la entrega eficiente de mensajes SMS y correos electrónicos, con características como:

  • Envío de correos electrónicos con archivos adjuntos o contenido base64
  • Seguimiento de notificaciones enviadas a través de cuentas específicas
  • Envío de SMS usando proveedores como Twilio

🌐 Información Base

  • Título de la API: cs-notifications-papi
  • Versión: 1.0.0
  • URL Base: cs-notifications-papi-prod-v1.us-e1.cloudhub.io/api

🚀 Primeros Pasos

  1. Autenticación: Asegúrate de tener el client_id requerido y el token Bearer OAuth 2.0.
  2. URL Base: Usa la URL Base proporcionada como prefijo para todos los endpoints de la API.
  3. Encabezados: Incluye los siguientes encabezados en tus solicitudes de API:-H "client_id: TU_CLIENT_ID"-H "Authorization: Bearer TU_ACCESS_TOKEN"

📍 Endpoints Disponibles

MétodoEndpointDescripciónEnlace de Exchange
POST/emailEnvía mensajes de correo electrónico.Ver detalles
GET/email/notification-trackObtiene detalles de tracking de correos enviados con la cuenta notification-track.Ver detalles
POST/smsEnvía mensajes de SMS.Ver detalles
POST/twilio/smsEnvía mensajes de SMS a través de Twilio.Ver detalles
GET/v2/email/notification-trackObtiene detalles de tracking de correos (versión 2), con soporte de providerId y accountId.Ver detalles
POST/bulk-email-processEnvío masivo de correos utilizando Notification Track.Ver detalles

📤 Ejemplo de Solicitud (Genérica)

curl -X POST "<endpoint>" \
-H "Content-Type: application/json" \
-H "client_id: TU_CLIENT_ID" \
-H "Authorization: Bearer TU_ACCESS_TOKEN" \
-d '{ "key": "value" }'

Reemplaza <endpoint> y el payload basado en el método específico.

⚠️ Manejo de Errores

Se utilizan códigos de estado HTTP estándar para el manejo de errores:

  • 200 OK – La solicitud fue exitosa
  • 400 Bad Request – Parámetros faltantes o inválidos
  • 401 Unauthorized – Falló la autenticación
  • 404 Not Found – Endpoint o recurso no encontrado
  • 500 Internal Server Error – Error inesperado en el servidor

📞 Soporte

Para asistencia, contacta al equipo de Coordinación de Servicios de Integración y Aplicaciones.

Correo electrónico: epalma@fgs.co

📅 Información Adicional

  • Documentación actualizada por última vez: Septiembre 2025
  • Para actualizaciones adicionales, consulta el Portal de Exchange de API

Documentación actualizada en Septiembre 2025 por epalma@fgs.co - Edna Nayibe Palma

© 2025 Fundación Grupo Social - Colmena. Archivo generado para la API cs-utilities-system-api-services

Reviews