RCS Analytics REST API
RCS Analytics REST API for SMSGatewayCenter APIs
RCS Analytics REST API
Use the Analytics REST API to fetch RCS message-volume metrics over HTTP, including today's totals, a date-range overview, daily trend, and direction or message-type breakdown. This endpoint accepts GET requests and returns JSON.
API Endpoint
https://unify.smsgateway.center/rest/rcs/v1/analyticsLegacy alias without v1 in the path is also supported: /rest/rcs/analytics
Authentication
Send your account userid with either password as a request parameter, or your account API key in the apikey request header. userid is required in both cases. Password is not required when the apikey header is used. RCS product and RCS API access must be enabled on your account. Do not publish live usernames or passwords.
Actions
| Action | Description | Default date range |
|---|---|---|
overview | Returns today's messages, range totals, daily trend, and message breakdown in one response. | Last 7 days |
today | Returns today's message totals only. | Today |
messagebreakdown | Returns totals grouped by direction and message type for the selected date range. | Last 7 days |
trend | Returns daily message volume for the selected date range. | Last 7 days |
| Parameter | Required | Description | Example/Value |
|---|---|---|---|
| Authentication | |||
| userid | Yes | Your SMSGatewayCenter account username. Required even when the apikey header is used. | YourUsername |
| password | Yes* | Your account password. Not required when the apikey header is used. | ********** |
| output | Yes | Response format. Must be json. | json |
| Optional Parameters | |||
| action | Optional | Defaults to overview. Allowed: overview, today, messagebreakdown, trend. | overview |
| fromDate | Optional | Start date for range-based actions. Format YYYY-MM-DD. Alias: from. Maximum range is 31 days. | 2026-07-11 |
| toDate | Optional | End date for range-based actions. Format YYYY-MM-DD. Alias: to. | 2026-07-17 |
Sample Request - Analytics Overview (cURL)
curl --location 'https://unify.smsgateway.center/rest/rcs/v1/analytics?userid=YourUsername&password=xxxxx&output=json&action=overview'
Sample Request - Today (cURL)
curl --location --get 'https://unify.smsgateway.center/rest/rcs/v1/analytics' \
--header 'apikey: YourApiKey' \
--data-urlencode 'userid=YourUsername' \
--data-urlencode 'output=json' \
--data-urlencode 'action=today'
Sample Success Response
{
"status": "success",
"analytics": {
"todayMessages": {"total": 40, "success": 38, "read": 20, "failed": 1, "pending": 0, "notSent": 1, "others": 0},
"rangeTotals": {"total": 250, "success": 230, "read": 140, "failed": 8, "pending": 0, "notSent": 12, "others": 0},
"dailyTrend": [
{"date": "Jul 08", "total": 30, "success": 28, "read": 18, "failed": 1, "notSent": 1}
],
"messageBreakdown": [
{"direction": 1, "msgType": 3, "total": 200, "success": 185, "read": 120, "failed": 6, "pending": 0, "notSent": 9, "others": 0}
]
},
"fromDate": "2026-07-11",
"toDate": "2026-07-17",
"statusCode": "200",
"reason": "success"
}
Sample Error Response
{
"status": "error",
"analytics": [],
"statusCode": "403",
"reason": "RCS API access is not enabled for this account."
}
Notes
- Date ranges cannot exceed 31 days.
- RCS analytics is message-volume only. There is no subscriber trend like Telegram Chat analytics.
action=listis treated asoverview.
Testimonials
