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-papi

This API enables efficient delivery of SMS messages and emails, with features such as:

  • Sending emails with attachments or base64 content
  • Tracking sent notifications through specific accounts
  • Sending SMS using providers like Twilio

🌐 Base Information

  • API Title: cs-notifications-papi
  • Version: 1.0.0
  • Base URL: cs-notifications-papi-prod-v1.us-e1.cloudhub.io/api

🚀 Getting Started

  1. Authentication: Ensure you have the required client_id and OAuth 2.0 Bearer token.
  2. Base URL: Use the provided Base URL as the prefix for all API endpoints.
  3. Headers: Include the following headers in your API requests:
-H "client_id: YOUR_CLIENT_ID"
-H "Authorization: Bearer YOUR_ACCESS_TOKEN"

📍 Available Endpoints

✉️ Email Delivery

MethodEndpointDescriptionExchange Link
POST/emailSends emails with attachments or base64 content.View on Exchange
GET/email/notification-trackRetrieves delivery tracking via configured accounts.View on Exchange
GET/v2/email/notification-trackRetrieves tracking with filters like providerId and accountId.View on Exchange

📱 SMS Delivery

MethodEndpointDescriptionExchange Link
POST/smsSends SMS messages using the default provider.View on Exchange
POST/twilio/smsSends SMS messages through Twilio provider.View on Exchange

📤 Request Example (Generic)

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

Replace <endpoint> and the payload based on the specific method.

📈 Diagram

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

⚠️ Error Handling

Standard HTTP status codes are used for error handling:

  • 200 OK – Request was successful
  • 400 Bad Request – Missing or invalid parameters
  • 401 Unauthorized – Authentication failed
  • 404 Not Found – Endpoint or resource not found
  • 500 Internal Server Error – Unexpected error on the server

📞 Support

For any issues, please contact the API support team:

Integration Services and Applications Coordination

📧 epalma@fgs.co

📅 Notes

Reviews