Using HTTP GET to Connect Custom SMS Gateways in BotSailor

BotSailor allows seamless integration of custom SMS gateways using HTTP GET requests. This is particularly useful when your SMS provider is not natively supported in BotSailor. By following a few simple steps, you can set up your custom SMS API and start sending messages directly through BotSailor's automation platform.

🧩 Use Case

This feature is ideal for:

Integrating regional or niche SMS gateway providers.
Using in-house or proprietary SMS systems.
Expanding support for more than the built-in providers like Twilio or Nexmo.

🔧 Steps to Integrate Custom HTTP GET SMS API

Step 1: Navigate to SMS Integration Settings

Go to the Settings menu from the left sidebar.
Click on SMS Integration under the "Settings and API Integration" section.

Step 2: Add a New SMS Profile

Click on the New button to create a new SMS profile.

Step 3: Choose HTTP GET and Provide API Details

In the modal that appears:

Select Http Get from the right-hand list.
Enter your custom API Name.
Paste your HTTP GET request URL in the provided field. This should be a fully functional URL with necessary query parameters (e.g., phone number, message, API key).

✳️ Note: Make sure your API endpoint supports GET requests. Example:

Step 4: Test and Save

Click on the Analyze and test call button to verify the URL is working.
Once confirmed, click Save to store your custom SMS gateway profile.

✅ Tips for Successful Integration

Always test the URL before saving.
Ensure proper encoding of query parameters.
Some gateways may require IP whitelisting — check with your provider.
Use placeholders like PHONE and MESSAGE that BotSailor will automatically replace during execution.

🧪 Example API Format

BotSailor will dynamically inject the phone number and message during the actual campaign or automation.

📌 Conclusion

Using HTTP GET to connect a custom SMS gateway in BotSailor is a quick and effective way to extend your communication reach, especially if your SMS provider isn't listed. With just a URL and a few configurations, your system is ready to automate SMS communications globally.

📌 Frequently Asked Questions (FAQs)

How can I integrate an SMS gateway that is not directly supported by BotSailor?

BotSailor allows you to integrate custom SMS gateways using HTTP GET requests. You need to navigate to the SMS Integration settings, add a new SMS profile, select "Http Get," and provide the API name and your custom API's HTTP GET request URL. This URL should include the necessary query parameters for sending an SMS, such as the recipient's phone number and the message content.

What information do I need to provide when setting up a custom HTTP GET SMS API in BotSailor?

You will need to provide the following information:

A custom API Name for your reference within BotSailor.
The complete HTTP GET request URL provided by your SMS gateway. This URL must include placeholders like PHONE and MESSAGE which BotSailor will replace with the actual recipient number and message content when sending an SMS. It may also include other necessary parameters like an API key.

How can I ensure that my custom HTTP GET SMS API is working correctly before saving it in BotSailor?

BotSailor provides an "Analyze and test call" button. After entering your HTTP GET request URL, click this button to verify if the URL is working and that BotSailor can communicate with your SMS gateway. This step is crucial to ensure successful integration.

What are some important considerations when integrating a custom HTTP GET SMS gateway with BotSailor?

Here are some important tips for successful integration:

Always test the URL using the "Analyze and test call" button before saving.
Ensure that the query parameters in your URL are properly encoded.
Check if your SMS gateway provider requires IP whitelisting and configure it accordingly.
Utilize the placeholders PHONE and MESSAGE in your API URL, as BotSailor will automatically replace these during SMS execution.