Product Manual

CPaaS Platform

Administrator Guide

Version 1.0  |  For Admin Role  |  Port 8087

Table of Contents

  1. Platform Overview
  2. Logging In
  3. Dashboard & Analytics
  4. User Management
  5. Template Approvals
  6. Sender ID Requests
  7. Routes & Strategies
  8. Campaign Monitoring
  9. Reports & Message Logs
  10. System Monitoring
  11. Blacklist Management
  12. Audit Logs
  13. Admin Account Management
  14. Glossary

1. Platform Overview

The CPaaS (Communications Platform as a Service) is a multi-tenant, multi-channel messaging platform that enables businesses to send SMS, WhatsApp, RCS, and Voice messages at scale.

Architecture at a Glance

ServicePortPurpose
Admin Dashboard8087Platform administration and configuration
User Portal8088Customer-facing messaging interface
Core API8081Central business logic and database
SMS Service8082SMPP/HTTP SMS gateway
WhatsApp Service8083WhatsApp Business API gateway
RCS Service8084RCS messaging via Virtuoso RBM

Supported Channels

As an Administrator, you have full platform access including user management, routing configuration, billing oversight, and system monitoring. The Admin Dashboard runs on port 8087.

2. Logging In

1
Open the Admin Dashboard

Navigate to http://localhost:8087 in your browser.

2
Enter Credentials

Enter your admin username and password. Admin accounts have role = ADMIN in the system.

3
Session Management

Sessions are maintained with secure HTTP-only cookies. Logout using the user menu in the top navigation bar.

Admin credentials must never be shared. If you suspect a compromise, immediately reset the password via the Admins management page.

3. Dashboard & Analytics

The dashboard is the first screen after login. It provides a real-time, platform-wide view of messaging activity.

Key Metrics Cards

MetricDescription
Total Messages (Today)Count of all messages sent across all accounts today
Success RatePercentage of delivered messages out of total submitted
Active UsersNumber of user accounts with activity today
RevenueTotal billing revenue generated today

Charts & Visualizations

AI Insights Panel

The dashboard includes AI-powered insights (via Ollama) that analyze:

The dashboard auto-refreshes every 15 seconds to show near-real-time data.

4. User Management

Navigate to Users in the left sidebar to view and manage all customer accounts.

4.1 Creating a New User

1
Click "Add User"

Use the button at the top right of the Users table.

2
Fill Basic Info

Enter username, email, phone, and a temporary password. The user must change it on first login.

3
Set Role

Choose USER for standard customer accounts.

4
Save

The account is created in the system. It is active by default.

4.2 Editing a User

Click the Edit button next to any user to open the full account editor. Key sections include:

SectionFields
Basic InfoUsername, email, phone, active status, whitelisted IPs
API CredentialsAPI Key (auto-generated), regenerate button
DLR WebhookURL where delivery receipt webhooks are sent
Channel EnablementToggle SMS / WhatsApp / RCS / Voice per account
SMS ComplianceTelemarketer ID, PE ID for DLT compliance
Route AssignmentAssign specific routes per channel (SMS, WA, RCS)

4.3 Pricing Configuration

Each user has independent per-channel pricing set by the admin. These rates are charged per message sent.

ChannelPricing Fields
SMSSMS Price per unit
WhatsAppUIC, MIC, SIC, Auth, Auth INT (5 category prices)
RCSRCS Price per message
VoiceVoice Price per minute/call
Changing pricing does not retroactively affect past messages — only future sends.

4.4 Assigning Channel Identities

Navigate to User Channels to assign WhatsApp WABA accounts and RCS Bots to users.

A user must have an active WABA or RCS Bot assigned before they can use those channels.

5. Template Approvals

Navigate to Templates in the sidebar. This screen shows all template requests from users that require admin approval (WhatsApp and RCS templates).

SMS templates are auto-approved when created. WhatsApp and RCS templates require admin review before they can be used in campaigns.

Approval Workflow

1
Review Template

Check template name, channel, type, and content. For media templates, verify the media URL is valid.

2
Approve or Reject

Use the Approve (green) or Reject (red) button. Rejected templates cannot be used until re-submitted.

3
Status Update

The template status updates to APPROVED or REJECTED. The user sees the status change in their portal.

Template Types

ChannelTypesApproval
SMSTextAuto-Approved
WhatsAppText, Media (image/video/document)Manual Review
RCSText Only, Rich Card (image/video + buttons)Manual Review

6. Sender ID Requests

Navigate to Sender Requests to manage sender ID approvals. Sender IDs are the alphanumeric strings that appear as the "From" name on SMS messages.

Fields in a Sender ID Request

In India, sender IDs must be registered with the DLT (Distributed Ledger Technology) portal. Verify PE ID before approval.

Approval Steps

1
Review Request

Verify the sender ID format and PE ID validity.

2
Approve or Reject

Click the status toggle. Approved sender IDs become available for the user to use in messages.

7. Routes & Strategies

Routes define how messages are delivered to end-users through carrier gateways. Routing rules determine which route is selected for each message.

7.1 Managing Routes

Navigate to Routes to manage carrier/gateway route configurations.

FieldDescription
Route NameUnique identifier used for queue naming (e.g., smpp1 → queue submit_smpp1)
ChannelSMS / WhatsApp / RCS / Voice
Host / PortSMPP or API gateway connection details
CredentialsSystem ID, password, or API key for the upstream gateway
ActiveOnly active routes can receive messages
Route names determine queue names. Changing a route name changes the queue name — ensure the corresponding gateway service is consuming the correct queue.

7.2 Routing Rules

Navigate to Routing Rules to configure how messages are routed per account and channel.

FieldDescription
AccountWhich user account this rule applies to (or ALL)
ChannelSMS / WhatsApp / RCS
RouteThe route (gateway) to send messages through
PriorityLower number = higher priority when multiple rules match
ActiveEnable or disable the rule

The system evaluates rules in priority order. The first matching active rule determines the route for a message.

7.3 Strategies

Navigate to Strategies to configure advanced routing algorithms, such as:

8. Campaign Monitoring

Navigate to Campaigns to view all bulk campaigns across all user accounts.

ColumnDescription
Campaign NameUser-defined campaign identifier
AccountThe user account that created this campaign
ChannelSMS / WhatsApp / RCS
StatusCREATED / QUEUED / PROCESSING / COMPLETED / FAILED
Total RecordsTotal phone numbers in the uploaded CSV
ProcessedRecords successfully submitted to the gateway
FailedRecords that encountered errors
Admins can monitor campaign progress in real-time but cannot modify campaigns created by users.

9. Reports & Message Logs

Navigate to Reports to access all message logs across the entire platform.

Available Filters

Message Log Fields

FieldDescription
RecipientDestination phone number
ChannelMessaging channel used
StatusCurrent delivery status
Provider Message IDID assigned by the upstream gateway (for DLR tracking)
CostAmount charged for this message
Sent At / Delivered AtTimestamps for key delivery events
Error CodeError code if delivery failed
CampaignAssociated campaign (for bulk sends)

Report Summary

Navigate to Report Summary for aggregated analytics charts per account or time period.

10. System Monitoring

Navigate to Monitoring for real-time visibility into all platform services.

Service Health

The monitoring page shows the status of each microservice:

ServiceStatus Indicators
cpaas-coreUP / DOWN with ping latency
cpaas-smsUP / DOWN
cpaas-whatsappUP / DOWN
cpaas-rcsUP / DOWN
RabbitMQQueue depths for all message queues

System Resources

RabbitMQ Queue Stats

View message counts for all queues:

If any queue depth is growing and not reducing, the corresponding gateway service may be down. Check the Service Health panel and restart the affected service.

Service Controls

From the monitoring page, you can start or stop individual microservices using the control buttons. Use with caution — stopping a service will halt message processing for that channel.

11. Blacklist Management

Navigate to Blacklist to manage globally blocked phone numbers.

Global Blacklist

Phone numbers on the global blacklist are blocked across all accounts. Messages to these numbers are silently dropped at submission time.

Per-Account Blacklist

Admins can also view per-account blacklists by filtering by account. Users can manage their own blacklists from the User Portal.

Adding to Blacklist

1
Enter Phone Number

Enter the full international format number (e.g., +919876543210).

2
Select Scope

Choose Global (all accounts) or a specific account.

3
Save

The number is immediately blocked. Future messages to this number are rejected at the submission layer.

12. Audit Logs

Navigate to Audit Logs to view a complete history of all system actions and changes.

What is Logged

Filtering Audit Logs

Audit logs are immutable and cannot be deleted. They are retained for compliance purposes.

13. Admin Account Management

Navigate to Admins to manage administrator accounts. Only existing admins can create new admin accounts.

Creating an Admin

1
Click "Add Admin"

Opens the admin creation form.

2
Fill Details

Enter username, email, and a strong password.

3
Set Role to ADMIN

Admin accounts have full platform access.

4
Save

The new admin can log in immediately at http://localhost:8087.

Admin accounts have unrestricted access to all platform data and settings. Create them only for trusted staff.

14. Glossary

TermDefinition
DLTDistributed Ledger Technology — India's regulatory system for commercial SMS
PE IDPrincipal Entity ID — The sender's registered ID on the DLT portal
WABAWhatsApp Business Account — Required for sending WhatsApp messages
RCSRich Communication Services — Next-generation SMS with rich media support
SMPPShort Message Peer-to-Peer — Protocol used by SMS gateways
DLRDelivery Receipt — Notification from the carrier confirming message delivery
UIC/MIC/SICUtility/Marketing/Service category for WhatsApp message pricing
FallbackAutomatic re-routing to a secondary channel when primary delivery fails
QueueRabbitMQ message queue holding pending messages for a gateway service
RouteConfiguration connecting the platform to an upstream carrier gateway
StrategyAlgorithm that selects which route to use for a given message
Provider Message IDUnique ID returned by the upstream gateway for tracking delivery