This article describes how to configure SMS Gateway Server using HF Web
(available via Admin > Admin Config > SMS Gateway Server)
What are SMS Gateways?
SMS Gateways are used to send text messages to employees within Humanforce product. It is used within the product to send shift offers and messages. The configuration currently supports two SMS providers that includes Message Media(preferred) and Whispir. The configuration allows you to setup multiple SMS Gateways and use them on a per location basis (If required)
Enabling Access
To activate these permissions:
- In HF Web, go to Admin > Security Config > Access Levels
- For the relevant Access Level row, click Edit
- Click on the Permissions tab
- Search for SMS Gateway
- Find the permissions under Maintenance Screens
- To access the SMS gateway server page, tick SMS Gateway
- After making your selection, click Apply Changes
Viewing, Adding and Editing SMS Gateway Server
To view the SMS Gateway Server page, Go to Admin > Admin Config > SMS Gateway Servers
The main SMS Gateway Server List page displays all configured SMS Gateways.
The page also offers the following functionality:
- Sorting (Available for Name and Address columns)
- Add
- Edit
- Delete
Adding/Editing an SMS Gateway
To add a new SMS Gateway, click the Add New SMS Gateway button in the top right of the screen.
To edit an existing SMS Gateway, click the edit (pencil) icon found in the Manage column against the record you wish to edit.
In the Add or Edit window that appears, you can edit:
- SMS Gateway - The preferred SMS Gateway Server option can be selected from the available drop-down list
- Name – The display name of the SMS Gateway Server, this is only relevant in the HF cloud and can essentially be anything
- Address – The address of the SMS gateway server that messages are to be sent through. This will be auto-populated on the SMS Gateway server selection but you can also make changes manually
- Username – SMS gateway username
- API Key - Is optional. Enter API Key
- Password/Secret Key – SMS gateway password
- CallBack AuthKey - CallBack AuthKey can be generated by clicking on the "Generate Key" button. It can also be manually be entered
- Source number - is optional. If not specified, one of the available numbers from the source number pool will be used. Note that if the source number is specified it MUST be a number from the source pool
- Default Country Code – Any employee mobile numbers that do not have a country code included will default to this country code. Note: do NOT include a plus sign. E.G. Australia (61) & New Zealand (64)
- Unit cost – The actual cost of units depends on the SMS gateway pricing plan, and is charged accordingly regardless of this field. This field is used only when calculating a cost estimate before sending a batch
- Retrieve Delivery Acknowledgement – Tick this box if delivery status/confirmation is required from the SMS provider. The acknowledgment will advise whether or not the SMS message reached the mobile handset
Delete an SMS Gateway
- To delete records, click the delete (bin) icon. Once the record is deleted it cannot be retrieved
- To avoid any records getting deleted by mistake, an actionable dialog box will be displayed
- Clicking on Delete will remove the record
- Clicking on Cancel will close the dialogue box