1. Home
  2. Docs
  3. Kiwire ( v3 ) – Administrator
  4. Integration
  5. SMS

SMS

The SMS module lets you setup SMS gateway over the internet.  The SMS module will be used by all SMS sending operation on Kiwire such as SMS campaign and SMS login function as well. Using SMS module, you can provide option for user to use OTP as password. OTP is to complete the SMS sign up as well as a new OTP code for every login.

NOTE:
Depending on your configuration of password security setting at Configuration – Settings, if it is set to high, all OTP code generated is alphanumeric and if set to low all the OTP code will be numeric only.

How SMS Module Work?

  1. When user performs signup for the network, Kiwire will determine if the login snippet is SMS to verify the account creation or SMS content send to the user will be the user credential.
  2. Kiwire will create an SMS message with the message composition under the SMS setting.
  3. The SMS gateway will send the SMS to the user’s mobile number.
  4. The user will key in the SMS code to log in.

NOTE:

There are three cloud SMS operators such as Twilio, Synchroweb & Generic. Please choose one cloud SMS operator to setup as SMS gateway over the internet.


Twillio Cloud SMS Gateway

Twillio is one of the world’s most popular cloud SMS providers. The Twillio cloud SMS option lets you configure Twillio as your cloud SMS gateway.

sms_twilio



The field and its function description is listed below.

FieldFunction
EnableEnable or disable the SMS integration function.
Cloud SMS OperatorSelect the Cloud SMS gateway platform from “Twillio” or “Synchroweb” or “Generic”.
Twilio Phone NoThe phone number associated with your Twilio account.
Twilio SIDYour own Twilio SID.
Twilio PasswordYour own Twilio Password.
Mode

Select operation mode

  • Send OTP to complete registration: User will use the code/password as verification to complete registration.
  • Send OTP every login : A SMS will be send for every login. User will be required to key in the code every time they login.
  • Send user password once registered : User will use the same code/password for subsequent login or use the SMS code as verification.
SMS ContentThe message of the SMS.
Link With ProfileIntegrate with a define plan *see account*.
ValidityThe expiry for new account sign up.
Once Registered

Select path after registered

  • Login User to Wifi : User can directly access to the wifi.
  • Follow Journey if Possible : User will go to the assigned journey first before able to successfully access the wifi.
Zone RestrictionDefault zone restriction assign to user that login. Leave it to “None” if you do not wish to assign restriction to users.
Prefix Phone No With +SignEnable / disable the prefix phone number with +sign.
Additional FieldsType your created field from data field and user will be prompt to key in the information when they sign up.




Synchroweb SMS Gateway

The Synchroweb tab is for configuration of Synchroweb cloud SMS gateway.

sms_synchroweb



The field and its function description is listed below.

FieldFunction
EnableEnable or disable the SMS integration function.
Cloud SMS OperatorSelect the Cloud SMS gateway platform from “Twillio” or “Synchroweb” or “Generic”.
API KeyThe Synchroweb API key.
Mode

Select operation mode

  • Send OTP to complete registration : User will use the code/password as verification to complete registration.
  • Send OTP every login : A SMS will be send for every login. User will be required to key in the code every time they login.
  • Send user password once registered : User will use the same code/password for subsequent login or use the SMS code as verification.
SMS ContentThe message of the SMS.
Link With ProfileIntegrate with a define plan *see account*.
ValidityThe expiry for new account sign up.
Once Registered

Select path after registered

  • Login User to Wifi : User can directly access to the wifi.
  • Follow Journey if Possible : User will go to the assigned journey first before able to successfully access the wifi.
Zone RestrictionDefault zone restriction assign to user that login. Leave it to “None” if you do not wish to assign restriction to users.
Prefix Phone No With +SignEnable / disable the prefix phone number with +sign.
Additional FieldsType your created field from data field and user will be prompt to key in the information when they sign up.

NOTE:

Enter the API Key generated from SMS Gateway Site.






Generic SMS Gateway

Due to the complexity and availability of other numerous cloud or internet SMS gateway around the world, the generic SMS tab let you adapt and use most of internet SMS gateway available as your SMS gateway. A common SMS protocol around all SMS gateway provider is the support of “Post” and “Get” SMS sending API. By configuring the Generic tab to suit your SMS provider you are able to utilize our open interface. Please saved the Generic tab first in order to be able to select the generic provider from the drop down of SMS gateway provider.


sms_generic



The field and its function description is listed below.

FieldFunction
EnableEnable or disable the SMS integration function.
Cloud SMS OperatorSelect the Cloud SMS gateway platform from “Twillio” or “Synchroweb” or “Generic”.
Request MethodThe method to access your SMS provider either via “GET” or “POST” protocol. Refer to your SMS gateway provider.
Full URIThe url of the SMS gateway to send SMS. Rrefer to your SMS gateway provider. Additional variable can be insert by adding to the url as url variable such as “account=var1&pass=var2”.
Variable Name for MessageThe variable for message encapsulation. Refer to your SMS gateway provider. The content of the message will be generated by Kiwire system.
Variable Name for Phone NumberThe variable for phone no encapsulation. Refer to your SMS provider.
HeadersCustom header for request.
Mode

Select operation mode

  • Send OTP to complete registration : User will use the code/password as verification to complete registration.
  • Send OTP every login : A SMS will be send for every login. User will be required to key in the code every time they login.
  • Send user password once registered : User will use the same code/password for subsequent login or use the SMS code as verification.
SMS ContentThe message of the SMS.
Link With ProfileIntegrate with a define plan *see account*.
ValidityThe expiry for new account sign up.
Once Registered

Select path after registered

  • Login User to Wifi : User can directly access to the wifi.
  • Follow Journey if Possible : User will go to the assigned journey first before able to successfully access the wifi.
Zone RestrictionDefault zone restriction assign to user that login. Leave it to “None” if you do not wish to assign restriction to users.
Prefix Phone No With +SignEnable / disable the prefix phone number with +sign.
Additional FieldsType your created field from data field and user will be prompt to key in the information when they sign up.




Example

In this example, we assume our SMS provider is call acme SMS gateway, and the Http get method to trigger SMS sending is

http://gateway.acmesms.com/sendsms.jsp?accountno [accountno]&password=[password given]&mobileno[phoneno]&msg=[sms text 

where the account no given is “myaccount”, password is “pass123” . the setup for the acme gateway will be as follow, Kiwire will append the replace the message and mobile no as per tag and generate the full URL and send the actual
SMS.

PREFIX

Prefix module will let you create a telephone prefix number for each country. On the prefix listing module, you may search for a specific prefix by using the search field.




The field and its function description is listed below.


FieldFunction
CountryThe name of the country.
PrefixThe telephone prefix number of the country.
Action

Modules action :

  • To delete the prefix.




ADD NEW PREFIX

Click on “Add Prefix” button and populate the required fields. Fill in the field with relevant information to complete the process.



The field and its function description is listed below.


FieldFunction
CountryThe name of the country.
PrefixThe telephone prefix number of the country.




DELETE PREFIX

Click on the delete icon to delete prefix. A prompt will be display to ask for your confirmation to proceed to delete the prefix. Please exercise with cautions as this not a reversible action.