2.1. How to add SMS provider
- Tomasz Kozierowski
Welcome to the next VoipSwitch tutorial. This time the guide will walk you through the process of adding an SMS provider in Voipswitch VSM4 portal.
To get started, please visit your VSM4 portal and log in.
1. Introduction
To seamlessly integrate a new SMS service provider into your system, follow the detailed instructions below. This guide covers everything from configuring protocols to setting up tariffs for accurate cost calculation.
2. Click "Providers"
To navigate to the SMS PROVIDERS section, start by clicking on 'SMS routing' in the menu, and then select 'Providers'.
3. Click "Add"
To start adding a new SMS provider, click the Add button located at the top of the page.
4. Click "Name"
Click on the NAME field and enter your name of provider.
5. Fill "Name"
This name will be visible in both the SMS routing plan and the CDRs.
6. Toggle "Calculate costs"
To activate cost calculations, simply toggle the "Calculate costs" switch. Once enabled (indicated by a green status), a dropdown field will appear next to it, allowing you to select your desired tariff.
7. Choose "Tariff"
Ensure that you select the tariff that aligns with the rates set by your provider, as Voipswitch determines SMS costs based on this selected tariff.
8. Set "SMS length"
Below, you can configure a text message length limit. By default, each message is limited to 160 characters. This means that clients can send longer messages; however, these messages will be divided into segments, each adhering to a character limit, and sent as multiple separate messages.
9. Set "SMS length for billing"
A similar scenario applies to SMS length for billing purposes. In this case, each SMS must adhere to a specified character limit. If a message exceeds this limit, the client will be charged for multiple messages rather than just one.
10. Choose "Type"
Below, you'll find one of the most crucial settings: the type of Provider. This setting allows you to select the communication protocol.
11. Choose "Type"
You can choose from standard protocols such as HTTP, SMPP or SIP, or opt for specialized options like Text-to-Speech callbacks or OTP callbacks. Depending on the protocol you select, a distinct set of configuration fields will be displayed.
12. Choose "HTTP"
The first type of protocol you can choose from is the HTTP protocol. This versatile protocol enables you to send messages seamlessly through external APIs. You can utilize it to make various types of requests, including the GET request or the POST request.
13. Choose "GET"
When you decide to use the GET type of HTTP request, you must provide the URL for the SMS provider.
14. Click "URL"
In this case, you need to click and enter the URL provided by the service provider.
15. Fill "URL"
Please note that you can utilize dynamic variable types, which will be populated with the appropriate data during execution, such as FROM, TO, or TEXT.
16. Choose "POST"
The second type of HTTP request is the POST request. This method operates similarly to the GET request, but with a key difference.
17. Fill "URL"
In addition to specifying the URL
18. Click "Content type"
you can also provide the Content-Type
19. Fill "Content type"
Fill in the text box with "application/x-www-form-urlencoded"
20. Click "Authorization header"
And the Authorization header
21. Fill "Authorization header"
And the Authorization header
22. Click "Data"
But most importantly, the request's data.
23. Fill "Data"
POST requests also allow the use of dynamic variable types, enabling you to populate fields such as FROM, TO, or TEXT with the appropriate data at execution time.
24. Choose "SIP"
The second type of protocol is SIP (Session Initiation Protocol). This protocol enables you to send messages directly to another SIP switch using the SIP method known as MESSAGE.
25. Click "Server address"
When you choose to use the SIP protocol, the first step is to configure the server address.
26. Fill "Server address"
This field accepts either a domain name or an IP address.
27. Click "User name"
Next, you have to enter your username credentials.
28. Click "Password"
And the password credentials.
29. Choose "SMPP"
The third standard protocol is the Short Message Peer-to-Peer (SMPP) protocol. This protocol enables you to send messages to another server that is equipped to handle SMPP communications.
30. Click "Server address"
When you choose to use the SMPP protocol, the first step is to configure the server address.
31. Fill "Server address"
Submit "2.2.2.2" in the appropriate field
32. Click "User name"
Next, you have to enter your username credentials.
33. Click "Password"
And the password credentials.
34. Choose "Encoding"
In addition, it is essential to choose the appropriate encoding.
35. Choose "DEFAULT"
You have the option to select from a variety of encoding types, or you can simply stick with the DEFAULT option.
36. Set up additional settings
There are additional parameters to consider. Please consult your provider to determine if these parameters are necessary and, if so, what specific values should be assigned to them.
37. Choose "Text-to-speech callback"
As we conclude our discussion on the protocol, it is essential to highlight some special options available. Please note that these options are available when you purchase the Callback Module or the Text-to-Speech Module. The first of these is the 'Text-to-Speech Callback.' This feature allows you to convert text messages into speech and initiate a call to the specified destination number. As a result, the end user will be able to listen to the SMS content.
38. Click "Destination number"
In this scenario, you need to configure the predefined callback destination number
39. Fill "Destination number"
Don't forget to also create a corresponding routing plan.
40. Choose "OTP callback"
The final type of protocol is the OTP callback, which closely resembles the previous one. However, in this instance, the code is extracted directly from the message, and then a call is initiated to the specified destination number. As a result, the end user will be able to listen to the OTP code.
41. Click "Destination number"
In this scenario, you need to configure the predefined callback destination number
42. Fill "Destination number"
And similiary to the "Text-to-speech callback" option don't forget to create a corresponding routing plan.
43. Click "Regular expression"
Finally, you will need to construct the regular expression for extracting the code.
44. Fill "Regular expression"
For instance, the expression "\d+" effectively extracts all digits from the entire message.
45. Toggle "Activity"
On the top of the window you are able to toggle the activity of the provider - green is active
46. Toggle "Activity"
whereas the color red indicates an inactive status.
47. Click "Save"
Congratulations! You've successfully created your first SMS provider. To finalize this process, simply click the SAVE button.
The guide covered the process of adding an SMS provider in Voipswitch VSM4 portal, including setting up protocols, entering provider details, and finalizing the setup by saving the changes. Follow the instructions to smoothly navigate through the process. Thank you for watching this tutorial. See you next time.