Whispir SMS Gateway is currently available in Humanforce cloud within the web app and backoffice application for sending Shift offers. SMS multi-factor authentication (MFA) login is currently not supported for Whispir gateway. Support for MFA will soon be added.
In order to set up the integration between Humanforce and Whispir, an authentication key needs to be generated from the SMS gateway within Humanforce. This is achieved by opening the SMS Gateway Server and selecting Generate Key. Once generated, take a copy of this key.
- Under the Set up menu in the Back Office, select SMS Gateway Servers.
- Add a new SMS Gateway.
- Choose Whispir from SMS Gateway and enter the Address *
- Name the gateway appropriately and generate key.
- Copy the AuthKey.
* Note the Address will need to reflect one of the below depending on the region.
| AU | https://api.au.whispir.com |
| AP | https://api.ap.whispir.com |
| AP1 | https://api.ap1.whispir.com |
| NZ | https://api.nz.whispir.com |
| US | https://api.us.whispir.com |
| IT | https://api.it.whispir.com |
| EDU | https://api.education.whispir.com |
Next, go to https://au.whispir.com and using the credentials supplied from Whispir, log into the Whispir site. Once you have logged in, select Settings > Company Settings > Portals & Apps > Manage API Callbacks.
Note: If you cannot see this option, you may need to have your permissions looked
at.
| Setting Name | Value |
| Call back Name | Name of SMS Gateway configured in Humanforce |
| Destination call back | The Clients HTTPS Humanforce URL followed by /callback/whispir |
| (eg https://humanforce.timetarget.com.au/callback/whispir) | |
| Expected Content Type | JSON |
| Invoke a call back for each message reply | On |
| Auth Type | HTTP Header |
| Auth Parameter | Enter the key generated from Humanforce |
| Rich Content Responses | Keep HTML in Response |
Once you have filled out all the details, select the test URL button before saving.
Deprecated Legacy Whispir configuration
Once you have saved the API call back, go to https://whispir.io/ and log in with the same credentials.
Once you have logged in, select My Apps and if there is no apps, select New App and enter a name/description which describes the client and environment (e.g. Humanforce UAT).
Once the app has been created, it will produce a key which is to be copied back into Humanforce back office SMS Gateway under the API Key. This is to then be followed by the users credentials. A completed setup will look similar to the below.
Things to Note
You will need to have high permissions within Whispir.
For using Whispir gateway in backoffice you will need to copy the SSL .DLL files to the Humanforce directory. Please contact a Humanforce consultant or create a Support ticket should they not be in the directory.
Within the Data Exchange task, SMS response, ensure that you have the “Download SMS responses from gate way” turned off. This is automatically handled within the API and not needed.