MumaraSMS+ offers integration with more than a few industry leading sending gateways like Infobip, Twililo and Clickatell etc. To configure your system with one of the available gateways, you need have your account ready with the particular gateway that you want to use for sending. After having an account, you would just need to provide few simple details belonging to your account to finalize the integration process.
Navigate to SMS Gateways
Main Navigation -> Setup -> SMS Gateways
The page where you would land by clicking SMS Gateways from the main navigation will show you a table with few columns. This table offers Information about the APIs of the sending gateways that was earlier being setup using “SMS Gateway” setting up API function. But to populate this table, you would need to first provide add a gateway by providing relevant API details. Here is how you do.
Add a Gateway
On the right side corner of the table's title bar, this button "Add a Gateway" takes you to the page where you'll provide the details of your desired Sending Gateway. Every company may require different details to authenticate the incoming API request and to connect with its gateway. Therefore, you will notice that some of the fields dynamically change when you select the “Company Name” from the first dropdown. Let’s see how it works.
Required Details to Setup Gateway API
Dropdown offers list of all gateways application is currently integrated with, i.e. Clickatell, Infobip, Twilio etc. You need to click on desired company’s gateway to open up relevant fields below.
Following area discusses the fields that you need to fill with appropriate information in order to setup Infobip’s sending gateway.
Infobip allows creating a unique API key as one of the requirement to authenticate the API request. Provide that particular API key in this field.
Secret key is another required parameter that infobip requires as authorization token to accept an API request. Put forward your infobip account’s secret key in this field.
Select your preferred pattern of sending SMS from the specific gateway, the dropdown has two options. Sending pattern largely depends on how the gateway accepts sending request from the application side. For example, SMSPlus only offers batch options when the selected gateway permits accepting the batch of contacts and further processes sending in batch.
1) Batches- When selected, SMSPlus will collect number of contacts suggested for a batch, and will supply the batch of contacts to the gateway for sending. When you select “Batches” as preferred pattern of sending, a field will appear underneath to select the suitable size of the batches.
2) Loop- For this option, system processes sending of the messages one by one.
Select “Active” to mark the status of the specific gateway as active and working. System will only use Gateways with Active status for sending. And if you don’t want to send from this gateway right now, you can mark the status of the gateway as “Inactive”.
Fallback Sender ID
In case if primarily preferred Sender-ID fails, system automatically shifts to the Sender-ID you will set as alternative in this “Fallback Sender ID” field. Primarily preferred Sender-ID can be the one that client has got approved for the sending, or the one that is given as application’s Default Sender-ID for the clients who don’t have their own Sender-ID approved. In case of the failure, system automatically shifts to the Fallback Sender-ID.
You can use this to upload gateway's logo to appear with the gateway name few places within the application. However, this is optional, if you don't want to upload a logo, you can leave it to continue.
If you want to write some additional details about the gateway you are integrating, this is again an optional field.
Most of the system required fields such as Name, Status, Fallback Sender-ID and Sending Pattern etc. will remain the same for every sending gateway; except for few unique fields that gateway requires to authorize API request and connect. So in case of setting up Clickatell API, following are the fields different than other gateways.
Unlike the API key of Infobip, Clickatell requires account username and password to authorize and connect. Provide the username of your account with Clickatell account and proceed.
Provide password of your Clickatell account in this field. As mentioned, rest of the fields will remain and work the same as mentioned above.
With Twilio, following are the two parameters that Twilio take into consideration to determine on the account from which the API request is initiated. Make sure, Twilio doesn’t allow sending in batches, therefore, you will only have the option of sending in loop.
For sending API request, Twilio requires providing two important credentials; the first one is the account SID which acts like username of your account. Provide your Twilio account SID here in this field.
Auth Token is like the password to the SID that you have just provided in the field above. Anyone without knowing this combination of valid SID and Auth Token will not be able to get the API request authorized by Twilio.
The table shows all available gateways system was integrated with. Since every sending gateway requires somewhat different information from the user side to authenticate the API request, therefore you may notice some of the “Rows” will remain empty for certain gateways in the “Available Gateways” table, like Username and Password field will remain empty for “Clickatell” and “Infobip”. Let's discuss the columns/rows of the table in detail.
Serial number of the records in the table
Gateway’s company name in the rows of this column
To authenticate the API request, some gateways require submitting the valid API key in the API request, like Infobip. So for Infobip, the row under this column shows the API key.
For Twiliio it shows the account SID under the same column.
Same goes for the secret key column, for Infobip, it shows the secret key of the Infobip account and for the Twilio, it is showing the Auth Token. For Clickatell that requires account’s username and password, fields for API Key and Secret key will remain empty.
Gateways that require account’s Username and Password for sending a valid API request will be having Username information in the respective row of the column. For Infobip and Twilio, the row under “Username” column will remain empty, while for the Clickatell, it will show the Username of Clickatell account that was being provided while setting up Clickatell API.
Password associated to the Username in row before.
For the Twilio it would need you to provide the account SID to appropriately setup the API.
To authenticate the API request, Twilio requires combination of account SID and valid API token. The rows of SID and Token are showing the Twilio SID and API Token.
Click to reach the Edit page, where you will be able to edit and update earlier saved API settings and preferences.