How to add a private SMS service provider

Modified on Fri, 14 Jun 2024 at 03:27 PM

Opting for the Private Service Provider feature enables seamless integration with any SMS service provider of your choice, extending flexibility beyond NotifyVisitors' pre-defined options. While NotifyVisitors already boasts a robust selection of integrated SMS service providers, we understand that your needs may require alternatives beyond this scope.

For those seeking to engage with service providers not included in our default options, this guide is crafted to meet your needs. By selecting the Private Service Provider option, you're empowered to manually add a service provider by completing a few essential fields. This ensures a personalized and customizable integration experience tailored to your specific business requirements and preferences.

Adding a private service provider

Integrating a private SMS service provider with NotifyVisitors is designed to be intuitive and straightforward. To initiate the setup process, navigate to the “Settings” section within your NotifyVisitors account. From there, select the “SMS” option, then “Add Service Provider” tab and click on “Add Service Provider” button.

In the "Add Service Provider" window that appears, choose "Private SSP" from the dropdown menu labeled "Select Service Provider." This option allows businesses to integrate custom service providers not included in NotifyVisitors' default options.

Now, fill in the essential API details required to establish a secure connection with the private SMS service provider.

  1. Name: First, give a unique name to your private SMS service provider configuration. This name helps in identifying and managing it easily in your NotifyVisitors account.
  2. Endpoint URL: Enter the Endpoint URL, which is basically the web address given by your private SMS service provider for smooth data exchange. This URL acts as a bridge between NotifyVisitors and the SMS service.
  3. Request Type: In order to continue, select the request type such as GET, POST, or PUT as per your service provider’s documentation.
  4. Basic authentication: Add Basic Authentication by entering the credentials provided by your private service provider. These credentials act as a secure key, ensuring that only authorized users can connect and share data.
  5. Body type: Next, you'll come across the "Body Type" section, which determines how data is structured and sent between NotifyVisitors and the private SMS service provider. Choose between "Form Data" and "Plain Text" based on your provider's requirements.

  • Form data: This option uses the traditional method of sending data in HTTP requests, organizing information as key-value pairs. Choose this if your private SMS service provider prefers this format. Simply fill in the key section, select liquid tags from the dropdown menu in the value section, and click "Add More Field" to add more key-value pairs.
  • Plain text: This format sends data as simple, unformatted text, making the data exchange process easier. To include dynamic variables like phone numbers, languages, or template names, simply select the desired token by clicking "Choose Token.” A liquid tag will automatically be added to the text, making it easier to integrate dynamic variables.
  1. Headers: Specify any particular headers or authentication tokens needed for secure and authorized communication with the Private SMS Service Provider in the "Header" section.
  2. Default sms service provider: Lastly, check the “Save as default” option if you want to set this service provider as your default.

After filling in all the necessary details accurately, click "Save" to complete the configuration. This step effectively integrates your private service provider into your NotifyVisitors account, allowing you to make use of a customized SMS service provider tailored to your individual requirements.

Setting up delivery tracking configuration

Delivery tracking configuration is crucial to receive status updates for all the messages sent through your private SMS service provider. These updates are valuable for monitoring message progress and ensuring successful delivery to your recipients.

After adding your private SMS service provider, click on the callback icon (the fourth icon) under the action column to set up delivery callbacks.

Upon clicking, a window for configuring delivery callbacks will appear, offering several options.

To configure delivery callbacks, follow these simplified steps:

Step 1: Integrate Delivery Tracking URL:

To begin receiving delivery status updates, you need to set up the delivery tracking URL. There are two options for this: configuring a webhook via the Partner Dashboard or including it in the Send Message API request.

Method A: Integrate delivery tracking URL

To receive delivery status reports from your SMS service provider, you can set up the delivery tracking webhook endpoint in your SSP's dashboard. Simply use the `dlr-callback-nv-reference` tag in the API request and map the corresponding response parameter in the webhook response.

Note

Kindly use the Webhook URL provided in your account for seamless integration.

Method B: API Configuration for SMS message delivery tracking URL

In this approach, you have the flexibility to set up the callback URL directly within the API request using the "dlr-callback-url" tag. This alternative method provides greater versatility and adaptability when configuring the delivery tracking system.

Instead of setting up the callback URL through a webhook, you can embed the "dlr-callback-url" tag directly within the body of your API request. This tag specifies the URL where delivery status updates will be sent.

To effectively implement this method, it's essential to consult the API documentation provided by your private SMS service provider. The documentation will provide detailed and specific instructions on how to integrate the tags into the structure of your API request.

Step 2: Send test message

After configuring the delivery tracking URL, send a test message to ensure everything is working correctly. Click the send test message button, add the necessary values, and click send.

Upon sending the test message, you will receive a delivery status report from your service provider, including Message ID, delivery status, and more.

Note

The test email window will only display the fields you added in the body data while configuring the private SMS service provider.

Step 3: Map desired attributes/fields in the delivery response

Finally, map specific fields in the delivery callback response, such as Unique Delivery ID, Delivery Status, Successful Delivery Status, Failed Delivery Status, and DLR Callback Reference. Click on each field, and a dropdown menu will display all the values from your test message response. Select the appropriate values according to the provided key.

After completing these mappings, click save to finalize your delivery callback configuration.

This delivery tracking configuration is a one-time process. Subsequently, when you send SMS campaigns, you'll receive delivery responses for all messages, indicating success or failure, along with details on any errors or reasons for failure.

Sending SMS campaigns via private SSP

Sending SMS campaigns via a private SMS service provider in NotifyVisitors involves a few steps to ensure a smooth campaign setup:

Begin by creating an SMS campaign tailored to your campaign needs. If you require guidance, refer to our comprehensive guide on "How to create a SMS campaign."

After entering the basic campaign information, proceed to the content section. Here, locate the "Service Provider" dropdown menu. Opt for "Private SSP" from the available choices, and then specify your private SMS service provider from the next dropdown menu and click on Continue to review.

Next, on the “Review” page, you can also view that the private SMS service provider is now selected for this campaign.

After verifying the details, proceed to send your campaign. It will then be directed through your private SMS service provider.

By following these steps, you can effectively send SMS campaigns via your private SMS service provider in NotifyVisitors, ensuring targeted and efficient communication with your audience.

SMS analytics

Upon sending an SMS campaign through a private SMS service provider, businesses can seamlessly access and analyze campaign analytics similar to regular SMS campaigns. To know more about SMS analytics Please refer to our article on “SMS campaign statistics”.

Also, to enable this functionality, it's crucial to ensure that delivery tracking is configured as explained earlier in the process. By adhering to these configurations, businesses can obtain insights into campaign performance, allowing for informed decisions and refined strategies for future messaging strategies.

Conclusion 

While NotifyVisitors offers various SMS service providers, businesses may have unique needs. Integrating a private SMS service provider provides unmatched flexibility, aligning precisely with specific business requirements.

Was this article helpful?

That’s Great!

Thank you for your feedback

Sorry! We couldn't be helpful

Thank you for your feedback

Let us know how can we improve this article!

Select atleast one of the reasons
CAPTCHA verification is required.

Feedback sent

We appreciate your effort and will try to fix the article