×
×
×
×

Configure SMS server for deployment alerts | OS Deployer

This article explains how to configure SMS Server Settings in OS Deployer. You can configure the API details of your preferred SMS Gateway Provider to receive SMS alerts for real-time inventory changes.

Prerequisites

  • An active account with the SMS Gateway Provider.
  • The SMS Gateway API URL must be reachable from the OS Deployer server.
  • Sufficient SMS credits must be available.

Refer to the API documentation provided by your SMS Gateway Vendor to validate these details.

Note: The SMS Server Settings feature is available from build 10.0.547.

Steps to Configure SMS Server Settings

  1. Log in to the OS Deployer web console and navigate to Admin > SMS Server Settings.
  2. Enter the API Endpoint URL for your SMS Gateway.
    Example: http://www.smsserver.com/sendsms
    https://api.clickatell.com/http/sendmsg
    Select the appropriate request method: POST or GET.
  3. Query Parameters
    Enter any required URL parameters:
    KeyValue
    parameter1data1
    parameter2data2
  4. Request Headers
    Add the required request headers:
    KeyValue
    Content-Typeapplication/json
    Authorizationxxxxxxxxxx
  5. Authentication
    If your SMS provider requires Basic Authentication, enter a username and password.
    Otherwise, select None.
  6. Request Payload (only for POST requests)
    Enter the body content to be included in the SMS request.
  7. Content Type
    Choose one:
    • application/json — payload is sent as JSON
    • application/x-www-form-urlencoded — payload encoded as form data
  8. Enter the expected Success Response message to validate delivery.
  9. Enter a Test Phone Number and verify message delivery.
  10. Enable Send SMS using Unicode if the text includes non-English characters.
  11. Click Save to apply the configuration.
Note: You can use the following placeholders in API parameters and payloads:
PlaceholderDescription
$recipient$Recipient’s phone number
$message$Message body text

You have now successfully configured SMS notifications in OS Deployer.

Was this document helpful?
Yes
No