Notification Settings API

Manage Notification Preferences for SMSGatewayCenter APIs

Introduction to Notification Settings API

Welcome to SMSGatewayCenter's Notification Settings API! This powerful API allows mobile app users to view and update their notification preferences for all messaging services. Configure alerts for SMS API, WhatsApp Business API, and Voice Call API. Settings are automatically filtered based on your account's allowed products, ensuring you only see relevant notification options. Our RESTful endpoints support POST and GET methods over HTTP for secure, flexible integration.

About Notification Settings

The Notification Settings API enables you to:

  • Read current notification preferences for your account
  • Update notification settings including balance alerts, usage summaries, and login notifications
  • Configure product-specific alerts for SMS, WhatsApp, and Voice Call services
  • Manage reseller alerts (for reseller accounts only)

All notification settings support multiple comma-separated email addresses for each alert type.


Read Notification Settings

Retrieve current notification preferences for the authenticated user. The API automatically returns only settings for products your account has access to.

API Endpoint

https://unify.smsgateway.center/SMSApi/notifications/read

HTTP Method

POST GET

 

Required Parameters
KeyValueDescription
Login Credentials (Required)
Authenticate your API request using userid-password or apiKey—choose one method.
useridYour Registered UsernameYour registered username; use if apiKey isn't provided. Signup for User ID
passwordYour PasswordURL-encoded password (for special characters); use if apiKey isn't provided. Signup for API Key
Header (optional) Parameters
apiKeyYour unique apiKeyapiKey needs to be sent as HTTP header when you are not using userid-password method. You can avail this from your user control panel and use instead of userid-password HTTP Request parameter. Please do not disclose this to anyone.

 

Request Parameters
ParameterTypeRequiredDescription
outputStringOptionalResponse format. Use json for JSON response (recommended)
Sample Request Code
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://unify.smsgateway.center/SMSApi/notifications/read",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "userid=YourUsername&password=YourPassword&output=json",
  CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache",
    "content-type: application/x-www-form-urlencoded"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Sample Response (SMS User)
{
  "response": {
    "api": "notifications",
    "action": "read",
    "status": "success",
    "msg": "Notification settings retrieved successfully",
    "code": 200,
    "count": 1,
    "notifications": {
      "balanceAlerts": {
        "enabled": true,
        "smsBalance": 1000,
        "smsAmount": "50.0000",
        "emails": "[email protected],[email protected]",
        "dailyBalanceAlert": {
          "enabled": true,
          "emails": "[email protected]"
        }
      },
      "smsAlerts": {
        "dailyUsageSummary": {"enabled": true, "emails": "[email protected]"},
        "weeklyUsageSummary": {"enabled": false, "emails": ""},
        "monthlyUsageSummary": {"enabled": false, "emails": ""},
        "monthlyDaywiseUsageSummary": {"enabled": false, "emails": ""},
        "latencyAlert": {"enabled": false, "emails": ""}
      },
      "creditTransactionAlerts": {
        "weeklySummary": {"enabled": false, "emails": ""},
        "monthlySummary": {"enabled": false, "emails": ""}
      },
      "loginAlerts": {
        "enabled": true,
        "emails": "[email protected]"
      }
    }
  }
}

Note: whatsappAlerts, voiceCallAlerts only appear if user has those products enabled. resellerAlerts only appear for reseller accounts (userType ≤ 2).


Update Notification Settings

Update notification preferences for the authenticated user. Only send parameters for products your account has access to—the API automatically filters settings based on allowed products.

API Endpoint

https://unify.smsgateway.center/SMSApi/notifications/update

HTTP Method

POST

 

Required Parameters
KeyValueDescription
Login Credentials (Required)
Authenticate your API request using userid-password or apiKey—choose one method.
useridYour Registered UsernameYour registered username; use if apiKey isn't provided. Signup for User ID
passwordYour PasswordURL-encoded password (for special characters); use if apiKey isn't provided. Signup for API Key
Header (optional) Parameters
apiKeyYour unique apiKeyapiKey needs to be sent as HTTP header when you are not using userid-password method. You can avail this from your user control panel and use instead of userid-password HTTP Request parameter. Please do not disclose this to anyone.

 

Request Parameters (Common - Available to All Users)
ParameterTypeRequiredDescription
Balance Alert Settings
enableBalanceAlertIntegerOptionalEnable balance alert: 1 = enabled, 0 = disabled
smsBalanceIntegerOptionalSMS balance threshold for alert trigger
smsAmountDecimalOptionalAmount threshold for alert (e.g., "50.00")
smsBalanceEmailsStringOptionalComma-separated email addresses for balance alerts
dailyBalanceAlertIntegerOptionalEnable daily balance alert: 1 = enabled, 0 = disabled
dailyBalanceAlertEmailsStringOptionalComma-separated email addresses for daily balance alerts
Credit Transaction Alerts
enableWeeklyCreditTransactionIntegerOptionalEnable weekly credit transaction summary: 1 = enabled, 0 = disabled
weeklyCreditTransactionEmailsStringOptionalComma-separated email addresses for weekly credit summaries
enableMonthlyCreditTransactionIntegerOptionalEnable monthly credit transaction summary: 1 = enabled, 0 = disabled
monthlyCreditTransactionEmailsStringOptionalComma-separated email addresses for monthly credit summaries
Login Alerts
enableLoginAlertIntegerOptionalEnable login alert: 1 = enabled, 0 = disabled
loginAlertEmailsStringOptionalComma-separated email addresses for login alerts
Output Format
outputStringOptionalResponse format. Use json for JSON response (recommended)
SMS Alert Parameters (Only for SMS Product Users - Product ID: 1)
ParameterTypeRequiredDescription
enableDailyUsageSummaryIntegerOptionalEnable daily SMS usage summary: 1 = enabled, 0 = disabled
dailyUsageSummaryEmailsStringOptionalComma-separated email addresses for daily SMS usage summaries
enableWeeklyUsageSummaryIntegerOptionalEnable weekly SMS usage summary: 1 = enabled, 0 = disabled
weeklyUsageSummaryEmailsStringOptionalComma-separated email addresses for weekly SMS usage summaries
enableMonthlyUsageSummaryIntegerOptionalEnable monthly SMS usage summary: 1 = enabled, 0 = disabled
monthlyUsageSummaryEmailsStringOptionalComma-separated email addresses for monthly SMS usage summaries
enableMonthlyDaywiseUsageSummaryIntegerOptionalEnable monthly daywise SMS usage summary: 1 = enabled, 0 = disabled
monthlyDaywiseUsageSummaryEmailsStringOptionalComma-separated email addresses for monthly daywise SMS usage summaries
latencyAlertIntegerOptionalEnable SMS latency alert: 1 = enabled, 0 = disabled
latencyAlertEmailsStringOptionalComma-separated email addresses for SMS latency alerts
WhatsApp Alert Parameters (Only for WhatsApp Product Users - Product ID: 5)
ParameterTypeRequiredDescription
enableWaDailyUsageSummaryIntegerOptionalEnable daily WhatsApp usage summary: 1 = enabled, 0 = disabled
waDailyUsageSummaryEmailsStringOptionalComma-separated email addresses for daily WhatsApp usage summaries
enableWaWeeklyUsageSummaryIntegerOptionalEnable weekly WhatsApp usage summary: 1 = enabled, 0 = disabled
waWeeklyUsageSummaryEmailsStringOptionalComma-separated email addresses for weekly WhatsApp usage summaries
enableWaMonthlyUsageSummaryIntegerOptionalEnable monthly WhatsApp usage summary: 1 = enabled, 0 = disabled
waMonthlyUsageSummaryEmailsStringOptionalComma-separated email addresses for monthly WhatsApp usage summaries
Voice Call Alert Parameters (Only for Voice Call Product Users - Product ID: 3)
ParameterTypeRequiredDescription
enableVcDailyUsageSummaryIntegerOptionalEnable daily Voice Call usage summary: 1 = enabled, 0 = disabled
vcDailyUsageSummaryEmailsStringOptionalComma-separated email addresses for daily Voice Call usage summaries
enableVcWeeklyUsageSummaryIntegerOptionalEnable weekly Voice Call usage summary: 1 = enabled, 0 = disabled
vcWeeklyUsageSummaryEmailsStringOptionalComma-separated email addresses for weekly Voice Call usage summaries
enableVcMonthlyUsageSummaryIntegerOptionalEnable monthly Voice Call usage summary: 1 = enabled, 0 = disabled
vcMonthlyUsageSummaryEmailsStringOptionalComma-separated email addresses for monthly Voice Call usage summaries
enableVcMonthlyDaywiseUsageSummaryIntegerOptionalEnable monthly daywise Voice Call usage summary: 1 = enabled, 0 = disabled
vcMonthlyDaywiseUsageSummaryEmailsStringOptionalComma-separated email addresses for monthly daywise Voice Call usage summaries
Reseller Alert Parameters (Only for Reseller Accounts - UserType ≤ 2)
ParameterTypeRequiredDescription
enableUsersBalanceIntegerOptionalEnable daily users balance alert for resellers: 1 = enabled, 0 = disabled
usersBalanceEmailsStringOptionalComma-separated email addresses for reseller users balance alerts
Sample Request Code (SMS User)
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://unify.smsgateway.center/SMSApi/notifications/update",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "userid=YourUsername&password=YourPassword&enableBalanceAlert=1&smsBalance=1000&smsAmount=50.00&[email protected],[email protected]&dailyBalanceAlert=1&[email protected]&enableDailyUsageSummary=1&[email protected]&enableWeeklyUsageSummary=0&weeklyUsageSummaryEmails=&enableMonthlyUsageSummary=1&[email protected]&enableMonthlyDaywiseUsageSummary=0&monthlyDaywiseUsageSummaryEmails=&enableWeeklyCreditTransaction=1&[email protected]&enableMonthlyCreditTransaction=0&monthlyCreditTransactionEmails=&enableLoginAlert=1&[email protected]&latencyAlert=0&latencyAlertEmails=&output=json",
  CURLOPT_HTTPHEADER => array(
    "cache-control: no-cache",
    "content-type: application/x-www-form-urlencoded"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
Sample Response (Success)
{
  "response": {
    "api": "notifications",
    "action": "update",
    "status": "success",
    "msg": "Notification settings updated successfully",
    "code": 200,
    "count": 1,
    "update": {
      "userId": 123,
      "updated": true,
      "timestamp": "2025-12-04T18:00:00+05:30"
    }
  }
}

Error Codes

Error CodeHTTP StatusDescription
200200Success - Request completed successfully
475400Invalid action. Supported actions: read, update
476500An error occurred while retrieving notification settings
477400Email validation error - Invalid email format detected
478400Failed to update notification settings. No changes made or nothing to update
479500An error occurred while updating notification settings
480405Create action is not supported. Use update action instead
481405Delete action is not available via API

Important Notes

Product-Based Filtering

  • Only send parameters for products your account has access to
  • The API automatically filters settings based on user's allowed products
  • SMS alerts require Product ID: 1
  • WhatsApp alerts require Product ID: 5
  • Voice Call alerts require Product ID: 3
  • Reseller alerts only work for reseller accounts (userType ≤ 2)

Email Validation

  • All email fields support comma-separated multiple emails
  • Email validation is performed on all email fields
  • Invalid email addresses will result in error code 477

Best Practices

  • Use the read action first to retrieve current settings before updating
  • Only include parameters you want to change in the update request
  • Test email addresses to ensure notifications are received
  • Configure balance alerts to avoid service interruption
  • Set appropriate thresholds for balance and usage alerts

Integration Examples

Example 1: Enable Balance Alerts Only

curl --location 'https://unify.smsgateway.center/SMSApi/notifications/update' \
--form 'userid="your_username"' \
--form 'password="your_password"' \
--form 'enableBalanceAlert="1"' \
--form 'smsBalance="1000"' \
--form 'smsAmount="50.00"' \
--form 'smsBalanceEmails="[email protected]"' \
--form 'output="json"'

Example 2: Enable Daily Usage Summary for SMS

curl --location 'https://unify.smsgateway.center/SMSApi/notifications/update' \
--form 'userid="your_username"' \
--form 'password="your_password"' \
--form 'enableDailyUsageSummary="1"' \
--form 'dailyUsageSummaryEmails="[email protected],[email protected]"' \
--form 'output="json"'

Example 3: Configure WhatsApp Alerts

curl --location 'https://unify.smsgateway.center/SMSApi/notifications/update' \
--form 'userid="your_username"' \
--form 'password="your_password"' \
--form 'enableWaDailyUsageSummary="1"' \
--form 'waDailyUsageSummaryEmails="[email protected]"' \
--form 'enableWaWeeklyUsageSummary="1"' \
--form 'waWeeklyUsageSummaryEmails="[email protected]"' \
--form 'output="json"'

Example 4: Reseller Configuration

curl --location 'https://unify.smsgateway.center/SMSApi/notifications/update' \
--form 'userid="reseller_username"' \
--form 'password="reseller_password"' \
--form 'enableUsersBalance="1"' \
--form 'usersBalanceEmails="[email protected]"' \
--form 'output="json"'

Testimonials

Why do Great Businesses Trust SMS Gateway Center?

K

Kurlon IT

2022-08-04

We have tied up with other SMS providers also, but SMS GatewayCenter is quite good. Good Service from the team. We are very happy with the service be it accounts related or technical issue. We always get good response.

I

INOX Air Products

2018-02-09

We have an excellent experience with SMS Gateway Center. The services and support has been of very high standard.

S

Shalabh Arora

2025-04-11

I’ve been using SMSGatewayCenter’s bulk SMS and WhatsApp services since early 2022 for my small business, and the experience has been fantastic. The platform is intuitive, and the message delivery is incredibly reliable, reaching my customers without fail. The 24/7 support team is quick to assist, and the cost-effectiveness is a big plus. It’s transformed how I connect with my audience, and I highly recommend it to other entrepreneurs! (Google Revirews)

R

Reflex

2025-04-11

We’ve been using your bulk SMS services for a few months, and the results have been phenomenal. The open rates and customer engagement have gone through the roof. Highly recommend for any business looking to scale fast! (Google Revirews)

V

Vedanth Gowda

2025-04-18

I’m Vedanth Gowda, leading a finance business, and I’ve been leveraging SMSGatewayCenter’s bulk SMS and WhatsApp tools —absolutely transformative! The platform’s speed and precision in delivering financial alerts to my clients are unmatched, giving me a competitive edge. Samrat’s expertise in tailoring notification workflows for market updates was a standout, and the robust security features instilled trust. The affordable pricing and proactive support team make it a no-brainer. Perfect for finance pros aiming to elevate client trust and efficiency! (Google Revirews)

N

Naval Bhatnagar

2025-04-12

From day one, the team at SMS GATEWAY CENTER guided us through setup, testing, and launching campaigns. Their support is A+. Whether you’re new to SMS marketing or experienced, they make it smooth. Thank you Aakash. (Google Revirews)


CTA for Unlock Real-Time Messaging – Integrate Today!

Unlock Real-Time Messaging – Integrate Today!

Try Our API in a Sandbox Environment Before Going Live!

Join Thousands of Developers – Try Our API Now!

Get in touchSign up