SMS Plug-In Configuration
The SMS plug-in enables a guest to obtain an Internet access code through SMS on a mobile/cellphone number and use this code to access the Internet. If the SMS plug-in is configured on the portal, guests can enter the mobile number on which they wish to receive an Internet access code through SMS.
JSON Table
| Parameter | Data Type | Description |
|---|---|---|
| success | boolean | Whether the API call was successful or not. |
| message | String | A message indicating the API success or failure. |
| data | application/json | A JSON object for the response data. |
| data/totalCount | int | The total number of records fetched. |
| data/smsConfig | application/json | A JSON for the SMS plug-in configuration. |
| data/smsConfig/pid | int | The system-generated ID of the portal. |
| data/smsConfig/username_msg91 | String | The MSG91 user account name. |
| data/smsConfig/password_msg91 | String | The password for the MSG91 user account. |
| data/smsConfig/sender_id_msg91 | String | The sender ID for the message. |
| data/smsConfig/date_created | Date | The date and time when the plug-in was initially configured. |
| data/smsConfig/sms_code_ttl | int | Time period in minutes for which the SMS code is valid. |
| data/smsConfig/sms_code_len | int | The character length of the SMS code. |
| data/smsConfig/sms_max_resend | int | The maximum number of times an SMS code can be resent. |
| data/smsConfig/sms_content | String | The content of the message to be sent through SMS. |
| data/smsConfig/sms_time_before_resend | int | The time period in seconds before the SMS code can be sent again. |
| data/smsConfig/sms_route_msg91 | int | The route that MSG91 must take to send the SMS. 1 indicates Promotional; 4 indicates Transactional. |
| data/smsConfig/session_timeout | int | The time period, in minutes, after which the guest user session expires. The user must re-authenticate to continue using the WiFi service. A value of zero indicates that the user session does not timeout and the user must explicitly log out from the portal. A non-zero timeout configured on the user account takes precedence over the timeout configured on the plug-in, portal, and the SSID profile in Wireless Manager. |
| data/smsConfig/blackout_time | int | The time period in minutes for which a user cannot log in to the portal after his last successful login has timed out. A value of zero indicates no blackout time. The blackout time, including zero value, configured on the user account takes precedence over the blackout time configured on the plug-in, portal, and the SSID profile in Wireless Manager. |
| data/smsConfig/date_modified | Date | The date and time when the plug-in was last re-configured. |
| data/smsConfig/landing_url | String | The URL of the page to which the guest user is redirected to on successful login using this plug-in. |
| data/smsConfig/bandwidth_upload_limit | int | Maximum upload bandwidth, in Kbps, for the guests using this plug-in. |
| data/smsConfig/bandwidth_download_limit | int | Maximum download bandwidth, in Kbps, for the guests using this plug-in. |
| data/smsConfig/service_id | String | The service used to send the SMS. The applicable values are msg91 and twilio. |
| data/smsConfig/account_sid_twilio | String | The Twilio user account name. |
| data/smsConfig/auth_token_twilio | String | The authentication token for the Twilio user account. |
| data/smsConfig/from_number_twilio | String | The from number for the Twilio user account. |
| data/smsConfig/account_health_msg91 | application/json | A JSON object representing the MSG91 account health. |
| data/smsConfig/account_health_msg91/errorMessage | String | A message indicating the status of the MSG91 account. |
| data/smsConfig/account_health_msg91/updateTime | String | The time when the MSG91 account health was last updated. |
| data/smsConfig/account_health_twilio | application/json | A JSON object representing the Twilio account health. |
| data/smsConfig/account_health_twilio/errorMessage | String | A message indicating the status of the Twilio account. |
| data/smsConfig/account_health_twilio/updateTime | String | The time when the Twilio account health was last updated. |
| data/smsConfig/sms_routes | application/json | A JSON listing the available routes for sending the SMS. |
Copy Sample JSON
Sample JSON
[{
"success": true,
"message": "Record Found",
"data": {
"totalCount": 1,
"smsConfig": {
"pid": 19,
"date_created": "2017-12-07 15:53:36.592551",
"sms_code_ttl": 5,
"sms_max_resend": 5,
"sms_content": "Your WiFi login code is .",
"session_timeout": null,
"blackout_time": null,
"sms_code_len": 6,
"sms_time_before_resend": 30,
"date_modified": "2018-04-06 11:25:28.198018",
"redirect_landing_url": null,
"bandwidth_upload_limit": null,
"bandwidth_download_limit": null,
"redirect_endpoint_id": null,
"device_limit": null,
"redirect_campaign_id": null,
"redirect_type": "redirect_landing_url",
"validator_endpoint_id": null,
"campaign": null
}
}
}]
API Calls
/V1.14/portals/{pid}/sms/config
/V1.14/portals/{pid}/sms/config