SMS Gateway APIs
Overview
The ‘SMS Gateways’ screen configures parameters that allow TASS.web and Staff Kiosk to send SMS messages through various providers. From here, you can access the SMS Queue, which shows all messages with a 'Queued' status.
It can be accessed by navigating to TASS.web System Admin > Utilities > API Gateway Maintenance, clicking on the ‘External APIs’ tab, and selecting ‘View’ for SMS Gateways.
Important!
Before setting up these parameters, follow the steps in the SMS Notification Setup Checklist.
You can use Staff Kiosk Staff > Meetings/Communications to test SMS functionality by sending a message to yourself or another school staff member.
User Security Permissions
To enable this API, users must have the ‘View' and ‘Edit’ permissions assigned to the '--- SMS Gateways' security point in TASS.web System Admin > Users > User Maintenance or TASS.web System Admin > Users > Security Role Permissions.
Refer to the SMS Notification Setup Checklist for instructions on activating permissions to send SMS from TASS.web and Staff Kiosk programs.
General Tab
The ‘General’ tab of the SMS Gateways screen includes an SMS Detail section that lets you configure parameters such as Messaging Format, Messaging Account ID, Account Password, and Multi-Part Messaging options. When TASS SMS is selected as the Messaging Format, you can also configure your display name, view your SMS credit balance, and set auto credit top-up triggers.
Field Label | Description | ||||||
|---|---|---|---|---|---|---|---|
Messaging Format | Select the format/provider to use if SMS Text messaging is enabled: Australian Schools For Australian schools, TASS.web currently interfaces with:
See the 'Other Licensing' page on the TASS Customer Hub for details.
Important! Users will need to obtain a registration code to create an account with Streetdata and use the TASS.web SMS messaging system. To receive a registration code from Streetdata, please call 0500 520 110, or (02) 9016 3829, or email: support@streetdata.com.au. You will then have to go online and enter the registration code that you have received from Streetdata to set up your Streetdata account by clicking on the following link: http://www.streetdata.com.au/admin/oemjoin.php. Once the account is created, you will be issued (via email) a username and password that will be entered into TASS.web in order to create the correct parameters for successful message sending. Important! Please be sure that you understand and accept the charges and conditions outlined by Streetdata before proceeding. South African and United Kingdom Schools
Important! Please be sure that you understand and accept the charges and conditions outlined by BulkSMS before proceeding. | ||||||
Messaging A/c Id | The SMS Gateway vendor will supply an account identifier to enter in this field once an account is created. | ||||||
Enable Multi-Part Messaging | Ticking this box will remove the normal *160 character limit for SMS messages. Important! Enabling multi-part messaging might lead to extra costs, as your school is charged per SMS. The standard SMS character limit is 160 characters. Messages longer than this could be split into several messages. *The text limit can be increased to 800 characters by enabling 'Multi-Part Messaging'. The payload of each multi-part message is 153 characters (rather than 160). When messages exceed 153 characters, they are split into multiple parts (2 or more of 153 characters each), allowing for the swift delivery of long messages. The caveat is that the additional message parts will incur additional costs. If you are interested in utilising SMS 'Multi-Part Messaging' for your school, please contact TASS Support for guidance. Please be aware that each multi-part message (153 characters) is charged as a single SMS. The checkbox will be greyed out (inactive) when the 'Message Format' is via email, as per the following list:
Important! Once enabled (ticked) and the 'Message Format' is set to Streetdata via Webservice Gateway, a pop-up message will be displayed informing the user that they must configure their SMS service for multi-part messaging. Failure to do so will result in truncated SMS messages. This field also controls the Push Notification character limits in Staff Kiosk Rollcall > Emergency Types (Setup). | ||||||
A/c Password | The SMS Gateway vendor will supply a password to enter in this field once an account is created. | ||||||
Display Name | This field is only used for 'TASS SMS'. There are three options that can be configured from this field:
| ||||||
Credit Balance | This field is only used for 'TASS SMS'. The current dollar balance of SMS Credits remaining will be displayed. | ||||||
Credit Package | This field is only used for 'TASS SMS'. The number of SMS credits that will be applied when the auto top-up is activated will be displayed. | ||||||
Auto Topup Trigger | This field is only used for 'TASS SMS'. SMS credits will automatically be topped up when the balance of credits reaches 10% of the original package amount. For example, if you purchased 50,000 credits, once your balance reaches 5,000 credits, you will be topped up with an additional 50,000 credits. | ||||||
Connection | This field is only used for 'TASS SMS'. Displays the status of the connection to the SMS Gateway. If the status is 'Failed', please contact Software Support. | ||||||
Communication | This field is only used for 'TASS SMS'. Indicates if the credentials used for the SMS account are valid. If the status is 'Failed', please contact Software Support. |
Manage Queue
The ‘Manage Queue’ icon at the top of the SMS Gateways screen opens the SMS Queue Maintenance screen and grid. It displays all messages with the status ‘Queued’.
User Security Permissions
To view the SMS Queue, users must have the ‘View' and ‘Edit’ permissions assigned to the ‘--- SMS Gateways' and '------ SMS Queue Maintenance’ security points in TASS.web System Admin > Users > User Maintenance or TASS.web System Admin > Users > Security Role Permissions.
Access to Cancel messages requires the ‘Edit’ Permission for the ‘ ------ SMS Queue Maintenance’ security point.
Display Filters
The display filters at the top of the screen let you define which data appears in the grid. You can filter by:
Date Range
Message Source: Attendance, Custom Roll SMS Messages, Parent Messages, Parent Teacher Interview Reminders, SMS Alerts or Student Illness Notifications.
Entity Type: Employee, Parent, or Student recipients.
Search for specific keywords.
Buttons
The buttons at the top of the screen perform various SMS Queue-related actions:
Button | Description |
|---|---|
 | The ‘< Back’ button returns users to the SMS Gateways screen. |
 | The ‘Refresh’ button |
 | The 'Cancel Messages' button activates when you select checkboxes from the grid. Cancel queued messages in bulk by selecting the 'All' checkbox, then clicking the 'Cancel Messages' button. Alternatively, tick individual messages to cancel, then click the 'Cancel Messages' button. A confirmation message will appear. Click 'Yes' to proceed. If any messages cannot be cancelled because their status changed after confirmation—such as being sent—they will trigger a notification. |
SMS Queue Maintenance Grid
The ‘SMS Queue Maintenance Grid’ is where users can view and manage unsent SMS messages and see details about the message source, recipient, content, date and time, mobile number, and status.
Grid Column | Description | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Source | The source of the SMS:
| ||||||||||||||
Entity Code | The TASS.web entity receiving the SMS: the employee, parent, or student code. | ||||||||||||||
Type | The recipient's entity type: 'Employee', 'Parent', or 'Student'. | ||||||||||||||
Message Text | The first 40 characters of the message will display. If the message length exceeds 40 characters, hover over the cell to view the entire message. | ||||||||||||||
Message Date and Time | The date and time that the message was sent. | ||||||||||||||
Mobile Number | The recipient's mobile number. | ||||||||||||||
Status | The status 'Queued' will display. SMS messages may be delayed during network congestion, such as during natural disasters or other events. For critical and urgent communications, please consider using multiple communication methods, such as app push notifications, Parent Lounge alerts, emails, calendar entries, or posting information on your school’s website. | ||||||||||||||
🔲 / ✅ | The checkbox column at the end of the grid allows you to select queued SMS and use the ‘Cancel Messages’ feature. |