Skip to content
ISPManISPMan Docs

SMS settings

Comms → SMS → Settings (/dashboard/sms/settings) controls two things: which messages ISPMan sends automatically, and whether SMS goes through ISPMan or through your own SMS provider. Click Save Settings when you are done. You see “SMS settings updated”.

Use Default SMS Settings

Section titled “Use Default SMS Settings”

Use Default SMS Settings is on by default.

  • On: ISPMan sends your SMS using its built-in SMS service, from the shared ISPMAN sender ID or your own registered sender ID. SMS is charged on your ISPMan bill or taken from prepaid units.
  • Off: ISPMan sends your SMS through your own SMS provider, using the Custom SMS API Settings below. ISPMan does not charge for these messages; your provider bills you.

Automatic SMS

Section titled “Automatic SMS”

Under Automatic SMS, choose which messages are sent to customers automatically:

Toggle Sends
Payment Confirmation A confirmation when a hotspot customer pays.
Hotspot Expiry SMS Expiry messages for hotspot customers.
PPPoE Payment Confirmation A confirmation when a PPPoE customer pays.
PPPoE Expiry SMS Expiry messages for PPPoE customers.
Static Payment Confirmation A confirmation when a static (fixed-IP) customer pays.
Static Expiry SMS Expiry messages for static customers.

To change the wording of these messages, bind templates to the events in SMS templates.

Use your own SMS provider

Section titled “Use your own SMS provider”

Turn off Use Default SMS Settings and fill in Custom SMS API Settings:

Field What to enter
SMS API URL Your provider’s send-SMS endpoint.
Sender ID The sender name registered with your provider.
API Key Your provider API key.
API Key Location Where the key goes in the request (see below).
API Schema (as JSON) The request body your provider expects, with placeholders. Click See guide for help.

API Key Location

Section titled “API Key Location”
  • header:x-api-key: put the key in a header named x-api-key.
  • If the key belongs in the request body, use the schema: put $API_KEY where the key goes.
  • query:token: add the key to the URL as ?token=... and still send the schema as the body.
  • headers:Client-ID,Client-Secret: send several headers. Put their values in API Key in the same order, separated by ;.
  • get:token: for providers that only accept GET requests. The schema and key are all sent as URL parameters.

API schema

Section titled “API schema”

The schema is a JSON object describing your provider’s request body. Use these placeholders and ISPMan fills them in for every message:

Placeholder Replaced with
$API_KEY Your configured API key.
$MESSAGE The message text. Required.
$RECIPIENT_NUMBER The customer’s phone number. Required.
$SENDER_ID Your sender ID from the field above.

Any other fields are sent exactly as written, for example a partnerID your provider gave you. Example:

{
  "apikey": "$API_KEY",
  "partnerID": "123",
  "message": "$MESSAGE",
  "shortcode": "$SENDER_ID",
  "mobile": "$RECIPIENT_NUMBER"
}

If the JSON is not valid you see “Invalid JSON format in API schema”.

Section titled “Related”