SMS - OTP

General Information

On the SMS OTP page, you can view detailed information about the SMS messages for your project in the Teliqon Portal. You can access this page from the left-side navigation menu:

The page contains the following elements:

1. Top panel for switching between tabs:

• a. SMS Settings;
• b. SMS Pricing List;
• c. List of Processed SMS

2. Detailed view of the selected tab.

The top panel for switching between tabs

The panel appears as follows:

When switching between tabs, the detailed information for the selected tab changes.

SMS Settings

You can configure SMS settings for your project using this tab:

The following SMS configuration options are available:

1. Code generation (On your side, On our side) - This code can be generated either on the client side or on the Teliqon Portal side. When the code is generated on the client side, it must be passed in the request to the Teliqon Portal API under the ‘api/info/otp/sms/send’ endpoint, in the parameter otp_code. An example of the request can be found in the ‘Working with API for sending SMS’ section.
2. Completing the code (Numbers, Letters, Special characters) - You can select one or more parameters here. The chosen parameters will determine the characters that will make up the code: Numbers, Letters, or Special Characters. Special characters refer to symbols such as !@#$%^&*(), etc. At least one type of character must always be selected.
3. Number of characters - The number of characters that will be used to generate the code.
4. Selection of an SMS template - Available templates for messages:

• a. {{ code }} is your verification code.
• b. Your code is {{ code }}. Do not share this code with anyone for account security.
• c. The code for {{ company }} is {{ code }}. Do not share the code with anyone.

5. Language - The language in which the SMS message will be generated for the user. To view the message text in a specific language, you need to select the language from the dropdown menu. Currently, there are 3 available language templates:

• a. English;
• b. German;
• c. Ukrainian.

6. Company / service name - The name of your company, which can be used in the template specified in the previous section 4c.
7. Callback URL - The domain specified in this parameter will receive a set of data based on the settings and the request_data_send_back parameter. If it is set to ‘true’, the information will be sent to the specified callback_url.
8. Response data - The set of data that will be sent to the callback_url specified in section 7. There are two options: it can either be the date of the SMS send result or the entire SMS send request along with the send result.

• a. Only data from our response;
• b. Data from our response + data from the request.

9. Buttons:

• a. Reset changes;
• b. Apply changes.

Once you have completed the settings and wish to save them, you need to click on ‘Apply changes’.

If you decide to cancel the changes, click on the ‘Reset changes’ button.

SMS Price List

You can view and calculate the cost of SMS for your project using this tab:

The page contains the following elements:

1. Pricing list block;
2. Cost calculator block.

Pricing list block

The pricing list block appears as follows:

The page contains the following elements:

1. Top toolbar;
2. Quick filters;
3. Data table;
4. Bottom toolbar.

To change the number of entries displayed on the page, you can use the dropdown list of page elements. Available options are:

1. 10 per page;
2. 15 per page;
3. 25 per page;
4. 50 per page;
5. 100 per page;
6. 250 per page.

The page features a search bar that allows you to conveniently search the pricing list by full or partial matches of characters in the 'Country' column. To use the search bar, simply click on it with your cursor, start typing the text using your keyboard, and then press ‘Enter’ or click the ‘Search’ button to the right of the search field.

Next to some columns, such as ‘Country’ and ‘Price’, there are ‘quick filters’ that allow you to easily and quickly sort the data.

Only one quick filter can be active at a time. It has 3 states, which can be toggled by clicking on the filter:

1. No sorting;
2. Sorting by descending order;
3. Sorting by ascending order.

Clicking on a different quick filter will reset the previously selected filter to its initial state (no sorting).

Additionally, below the table, there is a bottom toolbar that appears as follows:

It allows you to use page pagination.

Cost calculator block

Cost calculator block appears as follows:

It consists of the ‘Clear’ button and a table for calculations.

The ‘Clear’ button resets all the applied settings.

To calculate the cost of a specific number of SMS for a given country, you need to select the country from the dropdown list in the Country* parameter, and then specify the number of SMS in the Number of SMS* parameter.

The Result parameter displays the calculated cost for sending the specified number of SMS to the selected country.

For example:

Processed SMS List

The page with the history of processed SMS appears as follows:

The page contains the following elements:

1. Top toolbar;
2. Table with the list of processed SMS;
3. Bottom toolbar.

The top toolbar contains the following elements:

1. Select the number of records per page. It has the following options:

• a. 10 per page;
• b. 15 per page;
• c. 25 per page;
• d. 50 per page;
• e. 100 per page;
• f. 250 per page.

2. A search field.

The page features a search bar that allows you to conveniently search the processed SMS by full or partial matches of characters in the Number column.

To use the search bar, simply click on it with your cursor, start typing the text using your keyboard, and then press ‘Enter’ or click the ‘Search’ button to the right of the search field.

Next to all columns in this table, there are 'quick filters' that allow you to conveniently and quickly sort the data.

Only one quick filter can be active at a time. It has three states, which can be toggled by clicking on the quick filter:

1. No sorting;
2. Sorting by descending order;
3. Sorting by ascending order.

Clicking on a different quick filter will reset the previously selected filter to its initial state (no sorting).

Working with the API for sending SMS

To begin sending SMS to your clients, you must first complete all the necessary settings, which are detailed in the SMS Settings section.

Once SMS is configured for your project on the Teliqon Portal, you will need to add a call to the ‘api/info/otp/sms/send’ API request at the moment you need to send an SMS to the user.

Here’s an example of a CURL request for sending an SMS:

CURL

curl --location 'https://api-e.teliqon.io/api/info/otp/sms/send' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer your_user_token' \
--data '{
  'callback_url': 'your_callback_url',
  'company': 'your_company_name',
  'language': 'en',
  'otp_code': 'code_to_be_sent_in_sms',
  'phone_number': 'number_to_send_sms_for',
  'request_data_send_back': true
}'

Here’s a detailed description of the possible values for the parameters:

1. 'Authorization’ - can be accessed on the SMS - OTP page -> Settings;
2. ‘callback_url’ - this is the address where the result of your request will be sent. Below is an example of the information that will be received at the callback_url after the SMS send request is processed:

JSON

{
  'id_state': '12363372',
  'sender': 'SMS',
  'phone': '380911111111',
  'text': 'The code for test1 is 3333. Do not share the code with anyone.',
  'num_parts': 1,
  'part_no': 1,
  'state': 'DELIVERED',
  'time': '2025-02-21 20:48:40'
}

1. ‘company’ - A parameter that can be used in the SMS text if the Template C is selected in the settings.
2. ‘otp_code’ - a parameter that should only be provided if you selected ‘Code generation: On your side’ in the settings. In the other case, you should send the SMS request without the ‘otp_code’ parameter, as the Teliqon portal will generate this parameter for you and send the result to your callback_url.
3. ‘phone_number’ - the recipient's phone number for the SMS message;
4. ‘request_data_send_back’ - a parameter that accepts true or false values and determines whether the request response will include detailed information. If this parameter is set to false, the following result will be returned in the response (without details):

JSON

{
    'status': 'success',
    'otp_code': 'SD02!&\'08('),
    'creation_date': '2025-02-21T21:57:41.882691107Z',
    'request_id': '7bebca95-ххххх-хххх-хххх-3a00fb022ed8'
}