How To Configure Custom SMS Gateway in miniorange IDP?
How To Configure Custom SMS Gateway in miniorange IDP?
An SMS Gateway is an application that allows your device or server to receive and send Short Message Service (SMS) between various telecommunication networks. These networks can range from local (within a specific area) or international networks. They use a wireless carrier to route text/push messages to mobile devices
By default, miniOrange provides and uses it's own SMS Gateway to send OTPs to users. If you have a custom SMS gateway configured, you can use the same to send SMS from your miniOrange account. Check out our list of Supported SMS gateways.
Note:
You can contact idpsupport@xecurify.com for adding your own gateway or if you need help with any SMS Gateway integration.
Follow the guide to configure SMS gateway in your account
Configuration steps for Custom SMS Gateway in miniOrange IDP:
- Log in to the miniOrange dashboard.
- From the left navigation section, go to Customization >> Custom SMS Provider.
1. Set Organization SMS Gateway
- Select the Set Organization SMS Gateway icon.
- Under the SMS Gateways section, you can see the following options. Select the gateway of your choice
HTTP API with GET Method enables users to send account information in query parameters to their SMS Gateway Providers. Note that the query string (name/value pairs) is sent in the URL of a GET request. A few examples of providers using the GET method include msg91, Clicksend, and BulkGate.
To configure your SMS gateway using GET method, follow the steps below.
- Select the Custom Gateway (GET Method) option in the SMS Gateways dropdown.
- Configure the SMS gateway using the following parameters:
| Parameter | Description |
|---|---|
| URL | https://api-mapper.clicksend.com/http/v2/send.php?method=http&username=YOURUSERNAME&key=YOURAPIKEY&to=##phone##&message=##message## |
| Content-type | application/json, application/x-www-form-urlencoded |
| Authentication Type | No Auth |
HTTP API with POST method is used to send data to a server to create/update a resource.
The data sent to the server with POST is stored in the request body of the HTTP request and sent to SMS Gateway Server.
Eg: POST /rest.messagebird.com/api/messages
Host: localhost
name1=value1&name2=value2
A few examples of providers using the POST method include Alibaba, Plivo, and MessageBird.
To configure your SMS gateway using POST method, follow the steps below.
- Select the Custom Gateway (POST Method) option in the SMS Gateways dropdown.
- Configure the SMS Gateway using the following parameters.
- For the Post Fields section, enter the following parameters.
| Parameter | Description |
|---|---|
| URL | https://rest.messagebird.com/api/messages |
| Content-type | application/json , application/x-www-form-urlencoded |
| Authentication Type | No Auth |
| Parameter | Description |
|---|---|
| Gateway Parameter for SMS Body | ##message## |
| Gateway Parameter for Recipient's Phone Number | ##phone## |
| Gateway Parameter Key | Gateway Parameter Value |
For Basic Auth Authentication type, configure the SMS gateway using the following parameters:
- For the Post Fields section, enter the following parameters.
| Parameter | Description |
|---|---|
| URL | https://rest.messagebird.com/messages |
| Content-type | application/json , application/x-www-form-urlencoded |
| Authentication Type | Basic Auth |
| User Name | Enter your user name |
| Password | Enter a password |
| Parameter | Description |
|---|---|
| Gateway Parameter for SMS Body | ##message## |
| Gateway Parameter for Recipient's Phone Number | ##phone## |
| Gateway Parameter Key | Gateway Parameter Value |
Twilio Communications APIs enable voice, messaging, and video conversations within the web and mobile apps. This facilitates developers to make easy communications between different apps.
Twilio can be used to send SMS, make Voice Calls and more, across the customer journey. All you need to do is integrate its API with miniOrange. Click here to know more:
To configure your SMS gateway using Twilio Gateway, follow the steps below.
- Select the Twilio Gateway option in the SMS Gateways dropdown.
- Configure the SMS gateway using the following parameters:
- For the Post Fields section, enter the following parameters.
- Click here to get the ACCOUNT SID and AUTH TOKEN.
| Parameter | Description |
|---|---|
| URL | https://api.twilio.com/2010-04-01/Accounts/YOURACCOUNTSID/Messages.json |
| Authentication | BasicAuth |
| Username | ACCOUNTSID |
| Password | AUTHTOKEN |
| Parameter | Description |
|---|---|
| Body | ##message## |
| To | ##phone## |
| From | YourTwilioPhoneNumber |
2. Test SMS Gateway Configuration
After saving the configuration, you can test your SMS Gateway with the following steps.
- Enter your mobile number in the STEP 1 field.
- Click on Test Configuration. You will receive an SMS with a 6-8 digit OTP on the mobile number you entered.
- Enter the OTP sent in the SMS and click on Validate to validate your phone number.
If you have any further queries. Please contact us at idpsupport@xecurify.com
Need Help? We are right here!
