cs-notifications-papi icon

cs-notifications-papi

0.0.x
(0 reviews)
This service is an API designed for processing and sending SMS and email messages. It allows users to send emails, track the delivery of email notifications, and send SMS messages, including through Twilio.

📋 Home - CS Notifications API

Welcome to the CS Notifications API documentation. This API allows you to send SMS and email messages, track notifications, and integrate with Twilio for SMS delivery. It's designed to facilitate communication management in your application.

🚀 Base URL

https://cs-notifications-{env}.us-e1.cloudhub.io/api/
  • Environment Options:
    • dev (Development)
    • qa (Quality Assurance)

🔐 Authentication

This API uses two security mechanisms:

  1. Client ID Enforcement - Requires a valid client_id in the header.
  2. OAuth 2.0 - Token-based authentication with Bearer tokens.

Example header:

-H "client_id: YOUR_CLIENT_ID" \
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

📍 Endpoints
1️⃣ POST /email
Description: Sends email messages with optional file attachments and base64 encoded PDF.

#### Example Request:

```bash
curl -X POST "https://cs-notifications-dev.us-e1.cloudhub.io/api/email" \
  -H "Content-Type: multipart/form-data" \
  -H "client_id: YOUR_CLIENT_ID" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -F "files=@/path/to/file" \
  -F "body={\"to\":\"recipient@example.com\", \"subject\":\"Subject\", \"body\":\"Email body\"}" \
  -F "base64=[Base64StringForPDF]"

2️⃣ POST /sms

Description: Sends an SMS message.

Example Request:
curl -X POST "https://cs-notifications-dev.us-e1.cloudhub.io/api/sms" \
  -H "Content-Type: application/json" \
  -H "client_id: YOUR_CLIENT_ID" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
  -d '{
        "to": "+1234567890",
        "message": "This is a test SMS"
      }'

3️⃣ GET /email/notification-track

Description: Get tracking details for emails sent using the notification-track account.

Example Request:
curl -X GET "https://cs-notifications-dev.us-e1.cloudhub.io/api/email/notification-track?filter={\"mail_to\":\"juan.garcia@correo.com\"}" \
  -H "Content-Type: application/json" \
  -H "client_id: YOUR_CLIENT_ID" \
  -H "Authorization: Bearer YOUR_ACCESS_TOKEN"

📦 Response Example

{
  "status": "sent",
  "message_id": "1234567890",
  "timestamp": "2025-02-06T12:00:00Z"
}

📈 Diagram

resources/cs-notifications-papi-40e72604-385e-4eca-bd51-1a22f99f08d2.png

📞 Support

For any questions or issues, please contact the API support team COORDINACION DESARROLLO DE SERVICIOS Y APLICACIONES DE INTEGRACIONES.

Notes

  • Documentation adjusted in February 2025.
  • For additional information, contact: epalma@fgs.co

Reviews