Ana içeriğe geç

SMS Settings

What is it for?

The SMS Settings screen decides how the password a guest receives when logging in to Wi-Fi by SMS is generated, the SMS text, and which group the guest is added to. If you want to use your own SMS provider, you enter its connection details here too.

How do I open it? In the left menu, click Settings → SMS Settings. To offer SMS login to guests, also use SMS Portal Settings.

Under the screen title it says You are here. Click Dashboard in the path line at the top to return to the home screen.

When do I use it?

  • You are turning on SMS login for the first time and want to set the password format and message text.
  • You want guests who log in by SMS to be added to a different group (speed, duration, quota rules).
  • You want to send with your own company's SMS account and sender title instead of Useroam's.

Before you start

  • Create the guest group first on Groups; the Group list only shows this device's groups.
  • If you use your own SMS provider, get the sending address (URL), username, password and parameter names from the provider.

Step by step

  1. In the left menu, click Settings → SMS Settings. The SMS API Settings card opens.

    SMS Settings link in the left menu and SMS API Settings card

  2. Set up the password and message:

    • Character Length: how many characters the password has. Use - and + or type the number (e.g. 6).
    • Character Type: Lowercase Letters Only, Uppercase Letters Only, Letters Only, Numbers Only or All. Since guests type on a phone, Numbers Only is the easiest.
    • Group: the group guests who log in by SMS are added to.
    • If the user is registered, send a new password: if on, a number that registered before gets a new password when it logs in again.
    • Message to be Sent: the SMS text, at most 160 characters. Write {password} where the password should go; add {username} for the username if you like. Example: Your Wi-Fi password: {password}

    Character Length, Character Type, Group, new password switch and message fields

  3. To use your own SMS provider, turn on Custom API:. If you choose Other in the SMS Provider list that opens, you enter the provider's details by hand:

    • URL: the provider's sending address (e.g. https://sms.example.com/api/send?). The parameters are appended to this address.
    • HTTP Method: GET or POST, whatever your provider requires.
    • Use Country Code or Add Zero to the Beginning of the Number: the format of the number. Only one can be on; turning one on turns the other off.
    • Send JSON body (application/json): turn this on if your provider expects JSON. The request is sent with a JSON body and Content-Type / Accept headers set to application/json.
    • Request Parameters: add rows with the green + and delete them with the red -. In each row type the Parameter name and Parameter Value. Use {mobileno} for the phone number and {msg} for the message.
    • Response Value: the value the provider returns on success (e.g. OK).

    Custom API on, Other provider fields and Request Parameters table

  4. If you choose Mobilisim (Ekomesaj) as SMS Provider, you only enter your account's Username, Password and Sender Title at that provider.

    Username, Password, Sender Title fields with Mobilisim (Ekomesaj) selected

  5. Click Save. The screen reloads and shows the values you saved; no separate confirmation message appears.

    Save button

Every field and button on the screen

Field / ButtonWhat it doesExample
Custom API:You can use your own SMS integration. To send SMS with the Useroam sender title, the custom option must be turned off.Off
Character LengthNumber of characters in the password.6
Character TypeWhich characters the password uses.Numbers Only
GroupGroup of guests who log in by SMS.Guests
If the user is registered, send a new passwordWhether a registered number gets a new password.On
Message to be SentSMS text, at most 160 characters.Your Wi-Fi password: {password}
SMS ProviderMobilisim (Ekomesaj) or Other. Shown only when Custom API is on.Other
URLThe provider's sending address.https://sms.example.com/api/send?
HTTP MethodGET or POST.POST
Use Country CodeThe number is sent with the country code.
Add Zero to the Beginning of the NumberA 0 is added in front of the number.
Send JSON body (application/json)The request is sent with a JSON body.
Request Parameters: Parameter, Parameter ValueThe fields your provider expects.gsm = {mobileno}
Response ValueValue returned on success.OK
Username, Password, Sender TitleYour Mobilisim (Ekomesaj) account and SMS sender title.
SaveSaves the settings.

Frequently asked questions

The SMS the guest receives has no password.
Make sure Message to be Sent contains {password}, exactly like that, including the curly brackets.

I want SMS to go out with our company name.
Turn on Custom API: and enter your own provider account. When it is off, SMS is sent with the Useroam sender title.

The group list is empty.
There is no group for this device yet. Create one on Groups.

SMS is not sent through my own provider.
Check that the URL ends the way your provider expects (e.g. with ?), that the phone and message values contain {mobileno} and {msg}, and that only one number format switch is on. See sending records on SMS / WhatsApp Reports.