HTTP API for SMS and Viber Campaigns

All requests must be sent to a URL of the form https://api.turbosms.ua/module/method.format, where the module/method corresponds to the API command available for invocation, and the format specifies the type of returned data. Currently, the response is only supported in JSON format. If you need a response in XML format or any other data format, please contact our support team, and we will add its support. Specifying the format is not mandatory, but we recommend always including it so that there won’t be any issues in the future if we change the default format. Currently, the default format is JSON.

Each request must include the authentication key. It can be passed in several ways:

• GET parameter token=AUTH_TOKEN;
• POST parameter token=AUTH_TOKEN if the Content-Type: application/x-www-form-urlencoded header is present;
• HTTP header Authorization: Basic AUTH_TOKEN;
• HTTP header Authorization: Bearer AUTH_TOKEN.

Data can also be sent in several ways:

• GET parameters (the total length of the URL cannot exceed 2000 characters);
• POST parameters if the Content-Type: application/x-www-form-urlencoded header is present;
• POST request containing JSON data and the Content-Type: application/json header;

Important! All JSON examples in this documentation are split into multiple lines for clarity, but in real interaction with the API, all JSON data must be in a single line. If you need to insert a line break in any value, use the \n character combination.

For any valid HTTP request, the API will always return an HTTP 200 status code. The overall response structure is as follows:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": null
}

• response_code – the numeric code for the request processing result, ranging from 0 to 999;
• response_status – the status of the request processing result, representing a brief description of the outcome;
• response_result – the response data, if provided by the method. It can be null, an object, or an array of objects.

Each module includes a ping method to test the API status, which returns the following response:

{
   "response_code": 1,
   "response_status": "PONG",
   "response_result": null
}

If you receive this response, it means the API is operating correctly and can be used.

Request Numbering

If you need a request to be executed only once, you can add the parameter sequence_id, which contains your unique request identifier. This parameter can contain up to 40 characters. If a request with the same identifier has already been executed within the last 30 days, the results of its execution will be returned, and the request will not be executed again. The response code will be FAILED_DUPLICATE_REQUEST. This parameter is not mandatory but is recommended for use when creating entity requests. Note that the request identifier is tied to a specific API method, meaning you can call another method with the same sequence_id.

Message Module

The module allows you to manage messages, such as creating campaigns, sending them, and checking delivery statuses. Its functionality will be expanded.

Method send

Example request URL:
https://api.turbosms.ua/message/send.json

The method allows you to send SMS and Viber messages, as well as supports hybrid Viber sending (if the message is not delivered via Viber, it will automatically be sent via SMS).

General structure of the request body:

{
   "global_parameter_1": "value",
   "global_parameter_2": "value",
   ...
   "global_parameter_X": "value",
   "recipients": [
      "recipient_1",
      "recipient_2",
      ...
      "recipient_X"
   ],
   "group_ids": [
      "group_id_1",
      "group_id_2",
      ...
      "group_id_X"
   ],
   "viber": {
      "local_viber_parameter_1": "value",
      "local_viber_parameter_2": "value",
      ...
      "local_viber_parameter_X": "value"
   },
   "sms": {
      "local_sms_parameter_1": "value",
      "local_sms_parameter_2": "value",
      ...
      "local_sms_parameter_X": "value"
   }
}

Depending on the type of message you want to send, the request body should include parameters viber or sms, or both for hybrid sending. When creating a message, global parameter values are used first, but they can be overridden with local parameters if needed. For example, you can specify a global parameter text, and if both viber and sms parameters are present, its value will be used for both Viber and sms messages. If a different text value is specified in the sms parameter, it will be used for sms. Thus, if the parameter value is the same for both message types, it can be specified only in global parameters without duplicating it in local ones.

Available Parameters

At least one of the recipients, recipients_vars and group_ids parameters must be present; passing recipients and recipients_vars in the same request is not allowed; all duplicate recipients will be ignored.

If no delayed sending time is specified and the created distribution has no more than 5 recipients, the messages will be sent immediately. This means you will only receive a response after these messages have been processed, which may cause some delay in receiving a response. If it is important for you to receive a response as soon as possible, specify a delayed send time, and the message will be queued and sent in a different thread. Viber messages are sent as promotional by default if the is_transactional parameter is not set.

Using the file_id parameter, you can send files to users, such as documents, invoices, and so on. To send a file, you need to pass the caption parameter together with file_id, where you can specify the file name, for example, "Invoice.pdf". This parameter can contain up to 25 Latin characters or up to 12 Cyrillic characters. The text, button, and image parameters must not be present.
The following file formats are supported: .doc, .docx, .rtf, .dot, .dotx, .odt ,odf, .fodt, .txt, .info, .pdf, .xps, .pdax, .eps, .xls, .xlsx, .ods, .fods, .csv, .xlsm, .xltx. Such messages are charged at the promotional rate.

You can also use file_id to send an image or a link on a button. For an image, simply specify the file_id of the corresponding image, in which case the image_url parameter will be ignored. If the caption parameter is specified and the action parameter is missing, the file will be sent as a link on a button. Such messages are charged at the promotional rate.

Please note that in a message with a poll, the text field can contain up to 85 characters, and the answer option can contain up to 50 characters. Surveys are charged as transactional messages; the is_transactional parameter has no effect and is simply ignored. You can specify between 2 and 10 answer options.

Features of sending by a pattern

Using the recipients_vars parameter, you can create messages by a certain pattern with variables, where personal values are substituted for each recipient. You can specify the pattern itself in the text parameter, using combinations like %1% as variables (from %1% to %8% are allowed), where 1 is the key of the variable whose value is taken from the recipients_vars parameter. This parameter must be an object with the following structure:

{
  "380XXXXXXXXX": {
    "1": "value_1",
    "2": "value_2",
    "3": "value_3"
  },
  "380YYYYYYYYY": {
    "1": "value_1",
    "2": "value_2",
    "3": "value_3"
  }
}

You can also specify the id of your activated pattern in the pattern_id parameter, then the pattern text will be taken from it. Please note that when this parameter is used, not only the pattern text but also all the other fields filled in it (sender, button, image, carousel cards, survey items) are taken from the pattern. Thus, it may be enough to pass only the recipients_vars and pattern_id parameters in the request. The value of the is_transactional parameter is formed automatically based on the type of the passed pattern.

If necessary, you can replace the values of the pattern fields with other values (for example, use a different link on the button of a Viber message pattern or send the message from a different sender); in that case pass the needed parameter in the request.

Product cards carousel

To send a message with a carousel of product cards, you need to pass an array of card objects, each of which contains: a title, image, caption, and URL of the main button, as well as the text and URL of an additional link.

You can use either image_url or file_id as the image; one of them must be present. The recommended image size is 215x185 pixels. A single carousel post can contain 2 to 5 product cards and is charged as an promotional message.

In response to a create message request, the server will return data with the following structure:

{
   "response_code": 802,
   "response_status": "SUCCESS_MESSAGE_PARTIAL_ACCEPTED",
   "response_result": [
      {
         "phone": "recipient_1",
         "response_code": 406,
         "message_id": null,
         "response_status": "NOT_ALLOWED_RECIPIENT_COUNTRY"
      },
      {
         "phone": "recipient_2",
         "response_code": 0,
         "message_id": "f83f8868-5e46-c6cf-e4fb-615e5a293754",
         "response_status": "OK"
      }
   ]
}

Here, the global parameters response_code and response_status contain the overall result of processing the request, and the response_result parameter returns an array of objects, each of which contains the result of processing a specific recipient from the request. The message_id parameter contains a unique identifier of the message by which you can retrieve the current delivery status. If it is impossible to send a message to that recipient, the message_id parameter will be null, and the response_code and response_status parameters will provide error information.

Examples of Message Sending Data

Sending an SMS, JSON POST request:

{
   "recipients": [
      "380678998668",
      "380503288668",
      "380638998668"
   ],
   "sms": {
      "sender": "TurboSMS",
      "text": "TurboSMS welcomes you!"
   }
}

The same data, GET request:

https://api.turbosms.ua/message/send.json?recipients[0]=380678998668&recipients[1]=380503288668&recipients[2]=380638998668&sms[sender]=TurboSMS&sms[text]=TurboSMS+welcomes+you%21&token=AUTH_TOKEN

Sending a Viber message:

{
   "recipients": [
      "380678998668",
      "380503288668",
      "380638998668"
   ],
   "viber": {
      "sender": "TurboSMS",
      "text": "TurboSMS welcomes you!"
   }
}

Hybrid sending of Viber:

{
   "recipients": [
      "380678998668",
      "380503288668",
      "380638998668"
   ],
   "group_ids": [
      "15",
      "23"
   ],
   "viber": {
      "sender": "TurboSMS",
      "text": "TurboSMS welcomes you on Viber!"
   },
   "sms": {
      "sender": "TurboSMS",
      "text": "TurboSMS welcomes you on SMS!"
   }
}

Hybrid sending of Viber with a limited message lifetime:

{
   "recipients": [
      "380678998668"
   ],
   "viber": {
      "sender": "TurboSMS",
      "text": "Your confirmation code: 4821",
      "ttl": 60
   },
   "sms": {
      "sender": "TurboSMS",
      "text": "Your confirmation code: 4821",
      "hybrid_ttl": 60
   }
}

In this example, we will wait up to 1 minute for the Viber message to be delivered, and the fallback SMS will be sent only if the Viber message is rejected immediately (the subscriber is not registered, has unsubscribed, etc.). If we do not receive a successful delivery status for the Viber message within 1 minute, the SMS will not be sent because the hybrid_ttl has already expired. This approach is useful for messages that become less relevant over time, such as one-time codes.

Sending an SMS at a specified time:

{
   "start_time": "2020-03-08 10:00",
   "recipients": [
      "380678998668"
   ],
   "sms": {
      "sender": "TurboSMS",
      "text": "Maksym, happy birthday!"
   }
}

Sending a file in Viber:

{
   "recipients": [
      "380678998668"
   ],
   "viber": {
      "sender": "TurboSMS",
      "file_id": 12345,
      "caption": "Contract.pdf"
   }
}

Sending a file as a link on a button in a Viber message:

{
   "recipients": [
      "380678998668"
   ],
   "viber": {
      "sender": "TurboSMS",
      "text": "An invoice of 1000 hryvnias has been issued for your order №12345.",
      "file_id": 23456,
      "caption": "Download Invoice"
   }
}

Sending a carousel of product cards in a Viber message:

{
   "recipients": [
      "380678998668"
   ],
   "viber": {
      "sender": "Super FOOD",
      "text": "Only today, on your birthday, we are giving you one of the dishes you ordered most often:",
      "carousel": [
         {
           "image_url": "https://www.willcookforsmiles.com/wp-content/uploads/2025/02/Avocado-salmon-rice-bowl-in-a-bowl.jpg",
           "title": "Bowl with avocado and salmon",
           "button_caption": "I want it!",
           "button_url": "https://super-food.com/order/birthday/bowl-avocado-salmon.html",
           "link_caption": "More details",
           "link_url": "https://super-food.com/bowls/bowl-avocado-salmon.html"
         },
         {
           "file_id": 123456,
           "title": "Tempura vegetables with shrimp",
           "button_caption": "Or this!",
           "button_url": "https://super-food.com/order/birthday/tempura-vegetables-shrimps.html",
           "link_caption": "More details",
           "link_url": "https://super-food.com/tempura/tempura-vegetables-shrimps.html"
         },
         {
           "file_id": 234567,
           "title": "Dragon Roll Platter",
           "button_caption": "Definitely",
           "button_url": "https://super-food.com/order/birthday/set-dragon-rolls.html",
           "link_caption": "More details",
           "link_url": "https://super-food.com/sets/set-dragon-rolls.html"
         }
      ]
   }
}

Sending a Viber message with a survey:

{
   "recipients": [
      "380678998668",
      "380503288668",
      "380638998668"
   ],
   "group_ids": [
      "15",
      "23"
   ],
   "viber": {
      "sender": "Super Shop",
      "text": "Did you like the items sent in your last order?",
      "survey": [
         "😍 Definitely yes",
         "😊 More likely yes than no",
         "🙄 More likely not than yes",
         "😕 Definitely no",
         "🤬 This is my last order from you!"
      ]
   }
}

Sending messages by a registered pattern without variables:

{
   "recipients": [
      "380678998668",
      "380503288668"
   ],
   "sms": {
      "pattern_id": 12345
   }
}

Sending by a registered pattern with its own variable values for each recipient:

{
   "sms": {
      "pattern_id": 12345,
      "recipients_vars": {
         "380678998668": {
           "1": "12:00",
           "2": "Nova Poshta"
         },
         "380503288668": {
           "1": "13:00",
           "2": "Ukrposhta"
         }
      }
   }
}

Sending with variables substituted into the text from the request, without a pattern:

{
   "recipients_vars": {
      "380678998668": {
         "1": "12345",
         "2": "12:00"
      },
      "380503288668": {
         "1": "12321",
         "2": "18:15"
      }
   },
   "sms": {
      "sender": "Magazin",
      "text": "Your order %1% will be delivered at %2%"
   }
}

Method sendmulti

Example request URL:
https://api.turbosms.ua/message/sendmulti.json

This method allows sending multiple send requests in a single HTTP request, saving the time spent on connecting to the API for each request. In other words, calling the sendmulti method with data for 100 requests will be faster than making 100 separate send requests.

General structure of the request body:

{
   "unique_key_for_request_1": {request_data_1},
   "unique_key_for_request_2": {request_data_2},
   ...
   "unique_key_for_request_X": {request_data_X}
}

The server response will return data in the following structure:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": {
      "unique_key_for_request_1": {response_data_for_request_1},
      "unique_key_for_request_2": {response_data_for_request_2},
      ...
      "unique_key_for_request_X": {response_data_for_request_X}
   }
}

The request and response data structures are identical to those of the send method.

Method details

Example request URL:
https://api.turbosms.ua/message/details.json

This method allows retrieving details of created messages. To do so, you need to pass a list of message_id as an array.

General structure of the request body:

{
   "messages": [
      "2d80c1c0-5e3c-78c9-134b-2fc4fcbfa0ba",
      "f83f8868-5e46-c6cf-e4fb-615e5a293754",
      "c51f4301-5e3c-78c9-134b-d1ce1e56a9ff",
      "c51f4301-5e3c-78c9-134b-d1ce1e56afd4",
      "c51f4301-5e3c-78c9-134b-d1ce1e56a3aa"
   ]
}

Response structure:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": [
      {
         "message_id": "2d80c1c0-5e3c-78c9-134b-2fc4fcbfa0ba",
         "sms": null,
         "viber": null,
         "response_code": 414,
         "response_status": "NOT_ALLOWED_MESSAGE_ID"
      },
      {
         "message_id": "f83f8868-5e46-c6cf-e4fb-615e5a293754",
         "sms": {
            "added": "2022-01-25 12:45:32",
            "start": null,
            "sent": "2022-01-25 12:45:32",
            "updated": "2022-01-25 12:45:37",
            "sender": "TurboSMS",
            "text": "TurboSMS welcomes you to SMS!",
            "recipient": "380678998668",
            "status": "Delivered",
            "price": 0.34,
            "segments": 1,
            "ttl": 86400
         },
         "viber": {
            "added": "2022-01-25 12:45:31",
            "start": null,
            "sent": "2022-01-25 12:45:31",
            "updated": "2022-01-25 12:45:32",
            "sender": "TurboSMS",
            "text": "TurboSMS welcomes you to Viber!",
            "recipient": "380678998668",
            "message_type": "promotional",
            "status": "Rejected",
            "rejected_status": "SRVC_NOT_VIBER_USER",
            "price": 0,
            "ttl": 3600,
            "caption": "",
            "action": "",
            "file_id": 0,
            "click_time": null,
            "is_transactional": 0
         },
         "response_code": 0,
         "response_status": "OK"
      },
      {
         "message_id": "c51f4301-5e3c-78c9-134b-d1ce1e56a9ff",
         "sms": null,
         "viber": {
            "added": "2022-01-27 17:13:50",
            "start": "2022-01-28 12:00:00",
            "sent": "2022-01-28 12:00:00",
            "updated": "2022-01-28 12:00:17",
            "sender": "TurboSMS",
            "text": "Maxim, happy birthday!",
            "message_type": "transactional",
            "recipient": "380678998668",
            "status": "Read",
            "rejected_status": "",
            "price": 0.36,
            "ttl": 100,
            "caption": "",
            "action": "",
            "file_id": 0,
            "click_time": null,
            "is_transactional": 1
         },
         "response_code": 0,
         "response_status": "OK"
      },
      {
         "message_id": "c51f4301-5e3c-78c9-134b-d1ce1e56afd4",
         "sms": null,
         "viber": {
            "added": "2022-01-27 17:13:50",
            "start": "2022-01-28 12:00:00",
            "sent": "2022-01-28 12:00:00",
            "updated": "2022-01-28 12:00:17",
            "sender": "Super Shop",
            "recipient": "380678998668",
            "message_type": "carousel",
            "text": "You haven't ordered anything in a long time, we miss you and are giving you a 10% discount 🤗",
            "carousel": [
               {
                 "image_url": "https://turbosms.ua/user-files/a67/71c/91b/1545256.jpg",
                 "file_id": 13572,
                 "title": "Bowl with avocado and salmon",
                 "button_caption": "I want it!",
                 "button_url": "https://super-shop.com/cart/add/bowl-avocado-salmon.html",
                 "button_clicks": 12,
                 "link_caption": "More details",
                 "link_url": "https://super-shop.com/items/bowl-avocado-salmon.html",
                 "link_clicks": 4
               },
               {
                 "image_url": "https://turbosms.ua/user-files/4ba/fc5/91d/15223508.png",
                 "file_id": 123456,
                 "title": "Tempura vegetables with shrimp",
                 "button_caption": "Or this!",
                 "button_url": "https://super-shop.com/cart/add/birthday/tempura-vegetables-shrimps.html",
                 "button_clicks": 17,
                 "link_caption": "More details",
                 "link_url": "https://super-shop.com/items/tempura-vegetables-shrimps.html",
                 "link_clicks": 9
               },
               {
                 "image_url": "https://turbosms.ua/user-files/f46/ce1/91b/123110.jpg",
                 "file_id": 234567,
                 "title": "Dragon Roll Platter",
                 "button_caption": "Definitely",
                 "button_url": "https://super-shop.com/cart/add/birthday/set-dragon-rolls.html",
                 "button_clicks": 21,
                 "link_caption": "More details",
                 "link_url": "https://super-shop.com/items/set-dragon-rolls.html",
                 "link_clicks": 5
               }
            ],
            "status": "Read",
            "rejected_status": "",
            "price": 0.36,
            "ttl": 100,
            "caption": "",
            "action": "",
            "file_id": 0,
            "click_time": null,
            "is_transactional": 0
         },
         "response_code": 0,
         "response_status": "OK"
      },
      {
         "message_id": "c51f4301-5e3c-78c9-134b-d1ce1e56a3aa",
         "sms": null,
         "viber": {
            "added": "2022-01-27 17:13:50",
            "start": "2022-01-28 12:00:00",
            "sent": "2022-01-28 12:00:00",
            "updated": "2022-01-28 12:00:17",
            "sender": "Super Shop",
            "recipient": "380678998668",
            "text": "Did you like the items sent in your last order?",
            "message_type": "survey",
            "survey": [
               "😍 Definitely yes",
               "😊 More likely yes than no",
               "🙄 More likely not than yes",
               "😕 Definitely no",
               "🤬 This is my last order from you!"
            ],
            "status": "Read",
            "rejected_status": "",
            "price": 0.36,
            "ttl": 100,
            "caption": "",
            "action": "",
            "file_id": 0,
            "click_time": null,
            "is_transactional": 0
         },
         "response_code": 0,
         "response_status": "OK"
      }
   ]
}

The response contains two objects: sms and viber, or null if the corresponding object is not found. The parameters of these objects correspond to the parameters of the message/send and message/status methods. The start parameter contains the scheduled sending time, if specified. The segments parameter indicates the number of sms segments, which affects the final cost of the message.

Method status

Sample call address:
https://api.turbosms.ua/message/status.json

This method allows you to retrieve message delivery status information by simply passing a list of message_id as an array.

General format of the request body:

{
   "messages": [
      "2d80c1c0-5e3c-78c9-134b-2fc4fcbfa0ba",
      "f83f8868-5e46-c6cf-e4fb-615e5a293754",
      "c51f4301-5e3c-78c9-134b-d1ce1e56a9ff"
   ]
}

Response structure:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": [
      {
         "message_id": "2d80c1c0-5e3c-78c9-134b-2fc4fcbfa0ba",
         "response_code": 414,
         "response_status": "NOT_ALLOWED_MESSAGE_ID"
      },
      {
         "message_id": "f83f8868-5e46-c6cf-e4fb-615e5a293754",
         "response_code": 0,
         "recipient": "recipient_2",
         "sent": "2020-01-29 10:19:21",
         "updated": "2020-01-29 10:21:32",
         "status": "Read",
         "channel": "viber",
         "type": "viber",
         "rejected_status": "",
         "click_time": "2020-01-29 10:22:54",
         "response_status": "OK"
      },
      {
         "message_id": "c51f4301-5e3c-78c9-134b-d1ce1e56a9ff",
         "response_code": 0,
         "recipient": "recipient_3",
         "sent": null,
         "updated": "2020-01-29 18:27:34",
         "status": "Queued",
         "channel": "sms",
         "type": "sms",
         "response_status": "OK"
      }
   ]
}

The sent parameter contains the time the message was actually sent. If its value is null, it means the message is still in the queue and will be sent later. The updated parameter reflects the time when the delivery status was updated. The channel parameter indicates which channel was used to send the message. The type parameter duplicates channel, is deprecated and will be removed. For Viber messages, the click_time parameter is also returned, containing the time the button in the message was clicked, or null if the button was not clicked.

Description of the status field values

Description of the rejected_status field values

If a Viber message could not be sent, this field will contain the reason. In the case of a successful send, this field will be an empty string.

Groups Module

The module allows you to work with groups of recipient numbers to which you can send bulk messages

Method create

Example request URL:
https://api.turbosms.ua/groups/create.json

This method creates a new group of recipient phone numbers. You must specify the group name (up to 100 characters) in the request. In response, you will receive the group’s id, which you must use in subsequent operations.

Example requests:

{
   "name": "Clients Kyiv"
}

Example response:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": {
      "id": 15,
      "name": "Clients Kyiv",
      "phones_count": 0,
      "added": "2026-02-26 12:00:00",
      "updated": "2026-02-26 12:00:00"
   }
}

Description of the Response Parameters

Method update

Example request URL:
https://api.turbosms.ua/groups/update.json

This method updates the settings of an existing group. The group_id parameter is required; currently, only the group name can be changed.

Example requests:

{
   "group_id": 15,
   "name": "VIP clients"
}

Example response:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": null
}

Method delete

Example request URL:
https://api.turbosms.ua/groups/delete.json

This method deletes a group of recipients. In the group_id parameter, you must provide the group’s id, which was obtained when calling the groups/create method.

Example requests:

{
   "group_id": 15
}

Example response:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": null
}

Method list

Example request URL:
https://api.turbosms.ua/groups/list.json

This method returns an array of objects containing user group data. If the request body is empty, data for all existing groups will be returned. If you pass a group’s id in the group_id parameter or its name in the name parameter, only data for the specified group will be returned. Please note that this method does not support pagination parameters. The structure of the objects in the response is identical to the response structure of the groups/create method. If you pass the with_phones parameter in the request, you will also receive an array of phone numbers in the group objects.

Example requests:

{
   "group_id": 15
}

{
   "name": "Clients Odesa",
   "with_phones": 1
}

Example response:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": [
      {
         "id": 23,
         "name": "Clients Odesa",
         "phones_count": 3,
         "added": "2026-02-27 13:24:41",
         "updated": "2026-02-29 19:32:28",
         "phones": [
            "380931234567",
            "380961234567",
            "380971234567"
         ]
      }
   ]
}

Example response (groups list):

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": [
      {
         "id": 15,
         "name": "VIP clients",
         "phones_count": 120,
         "added": "2026-02-26 12:00:00",
         "updated": "2026-02-27 09:40:00"
      },
      {
         "id": 23,
         "name": "Clients Odesa",
         "phones_count": 3,
         "added": "2026-02-27 13:24:41",
         "updated": "2026-02-29 19:32:28"
      },
      {
         "id": 27,
         "name": "Clients Harkiv",
         "phones_count": 83,
         "added": "2026-02-28 10:12:54",
         "updated": "2026-03-01 17:51:14"
      }
   ]
}

Metod addPhones

Example request URL:
https://api.turbosms.ua/groups/addPhones.json

This method adds the phone numbers passed as an array to the group specified in the group_id parameter. In response, you will receive a brief summary in the summary parameter, which will include counters for the total number of phone numbers, as well as the number of successfully and unsuccessfully processed phone numbers, and an array of objects describing errors in the errors parameter. If all numbers are processed successfully, failed will be zero, and errors will be an empty array. The response code for the request will be SUCCESS_PROCESSEDB or SUCCESS_PARTIAL_PROCESSED, depending on whether all the submitted numbers were successfully processed.

Example requests:

{
   "group_id": 15,
   "phones": [
      "380000000000",
      "380501234567",
      "380661234567",
      "380671234567",
      "380751234567",
      "380771234567",
      "380931234567",
      "380961234567",
      "380971234567",
      "380991234567"
   ]
}

Example response:

{
   "response_code": 805,
   "response_status": "SUCCESS_PARTIAL_PROCESSED",
   "response_result": {
      "summary": {
         "group_id": 15,
         "processed": 10,
         "added": 8,
         "failed": 2
      },
      "errors": [
         {
            "phone": "380000000000",
            "response_code": 305,
            "response_status": "INVALID_PHONE"
         },
         {
            "phone": "380961234567",
            "response_code": 433,
            "response_status": "NOT_ALLOWED_GROUP_PHONE_DUPLICATE"
         }
      ]
   }
}

Method removePhones

Example request URL:
https://api.turbosms.ua/groups/removePhones.json

This method removes the phone numbers, passed as an array, from the group specified in the group_id parameter. The response is identical to that of the groups/addPhones method.

Example requests:

{
   "group_id": 15,
   "phones": [
      "380000000000",
      "380661234567",
      "380638998668",
      "380991234567"
   ]
}

Example response:

{
   "response_code": 805,
   "response_status": "SUCCESS_PARTIAL_PROCESSED",
   "response_result": {
      "summary": {
         "group_id": 15,
         "processed": 4,
         "removed": 2,
         "failed": 2
      },
      "errors": [
         {
            "phone": "380000000000",
            "response_code": 305,
            "response_status": "INVALID_PHONE"
         },
         {
            "phone": "380638998668",
            "response_code": 432,
            "response_status": "NOT_ALLOWED_GROUP_PHONE"
         }
      ]
   }
}

Senders Module

This module provides functionality for working with sender IDs: registering new ones, revising rejected ones and retrieving their current statuses. Currently, only SMS senders (alpha names) are supported, but to expand functionality in the future, it is mandatory to pass the channel parameter with the value sms in all module methods (the deprecated synonym type still works but will be removed). If you pass a different value or omit the parameter entirely, you will receive the response code INVALID_SENDER_CHANNEL.

Sender ID data

Method create

Example call address:
https://api.turbosms.ua/senders/create.json

This method creates an application for registering a new sender ID. All fields are required. In response you get the id of the sender ID to use in further operations, and its status — a newly created sender ID is always in the moderate status.

Request example:

{
   "channel": "sms",
   "name": "SuperShop",
   "profile": {
      "contractorName": "Super Shop LLC",
      "contractorCode": "12345678",
      "link": "https://super-shop.com",
      "messageExample": "Your order #12345 has been handed over to the delivery service",
      "description": "Order status notifications of an online store",
      "countries": [
         "UA",
         "PL"
      ]
   }
}

Response example:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": {
      "id": 4521,
      "type": "sms",
      "channel": "sms",
      "status": "moderate"
   }
}

Method update

Example call address:
https://api.turbosms.ua/senders/update.json

This method changes the data of an existing sender ID. Only channel and id are required, the remaining fields are passed as needed — only the fields present in the request are changed.

Only sender IDs in the moderate and revision statuses can be edited. An attempt to change a sender ID in any other status, as well as one that does not belong to you, returns the NOT_ALLOWED_SENDER code. Any change sends the sender ID back to moderation.

Request example:

{
   "channel": "sms",
   "id": 4521,
   "profile": {
      "messageExample": "Your order #12345 has been handed over to the Nova Poshta delivery service",
      "countries": [
         "UA"
      ]
   }
}

Response example:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": null
}

Method list

Example call address:
https://api.turbosms.ua/senders/list.json

This method returns an array of objects with the user's sender ID data, from the newest to the oldest. If nothing but channel is passed, all sender IDs are returned. Passing id returns the data of a single sender ID, and passing status returns only the sender IDs in that status. Please note that this method does not support pagination parameters.

Request examples:

{
   "channel": "sms"
}

{
   "channel": "sms",
   "status": "revision"
}

Response example:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": [
      {
         "id": 4521,
         "type": "sms",
         "channel": "sms",
         "name": "SuperShop",
         "status": "national",
         "moderator_info": "",
         "profile": {
            "contractorName": "Super Shop LLC",
            "contractorCode": "12345678",
            "link": "https://super-shop.com",
            "messageExample": "Your order #12345 has been handed over to the delivery service",
            "description": "Order status notifications of an online store",
            "countries": [
               "UA",
               "PL"
            ]
         }
      },
      {
         "id": 4498,
         "type": "sms",
         "channel": "sms",
         "name": "SuperFOOD",
         "status": "revision",
         "moderator_info": "Provide a link to an active company website",
         "profile": {
            "contractorName": "Super Food LLC",
            "contractorCode": "87654321",
            "link": "https://super-food.com",
            "messageExample": "Your order is ready for pickup",
            "description": "Order readiness notifications",
            "countries": [
               "UA"
            ]
         }
      }
   ]
}

Description of the status values

Chat Module

This module provides functionality for working with Viber chats.

Method senders

Sample call address:
https://api.turbosms.ua/chat/senders.json

This method returns an array of objects with the user's sender data. If the request body is empty, data for all senders that have ever been active will be returned. If you pass the sender ID to sender_id or its name to sender, only data for the specified sender will be returned.

Response structure:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": [
      {
         "id": 1,
         "name": "TurboSMS",
         "status": "OK",
         "logo_url": "/user-files/viber-logo/0e1/ed0/eb7/5bed39ee1c676789700607.png",
         "start_date": "2020-01-01",
         "reserve": 8400,
         "spent": 1234.56,
         "balance": 7165.44,
         "paid_date": "2023-12-01",
         "2way": 1,
         "recipients": 34567,
         "unread_messages": 7,
         "last_message_date": "2022-10-01 15:34:18"
      },
      {
         "id": 2,
         "name": "Mobibon",
         "status": "OK",
         "logo_url": "/user-files/viber-logo/fc4/163/53a/7c193960f07a63ce553dbd6235bc0a80.png",
         "start_date": "2020-01-01",
         "reserve": 8400,
         "spent": 2345.67,
         "balance": 6054.33,
         "paid_date": "2099-01-01",
         "2way": 0,
         "recipients": 0,
         "unread_messages": 0,
         "last_message_date": ""
      }
   ]
}

Description of the Response Parameters

Method recipients

Example request URL:
https://api.turbosms.ua/chat/recipients.json

This method returns an array of the sender's recipients. The sender can be specified either using the sender_id parameter with its ID or using the sender parameter with its name. Since there may be many recipients, there is an option to select a limited number of records with pagination support. Use the page parameter to pass the page number and rows for the number of records to return. By default, a set of 30 recipients is returned, with a maximum rows value of 500. Adding the new_only parameter will return only those recipients with unread messages, up to 30 per request. You can also pass an array of recipients whose data you want to receive in the recipients parameter. If this parameter is missing, all recipients of the passed sender will be returned.

Example requests:

{
   "sender_id": 1,
   "page": 10,
   "rows": 50
}

{
   "sender": "TurboSMS",
   "new_only": 1
}

Example response:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": [
      {
         "chat_id": 1234,
         "number": "380501234567",
         "contact_id": 2345,
         "name": "Vasiliy Pupkin",
         "total_messages": 123,
         "unread_messages": 3,
         "last_message_date": "2022-10-03 12:51:38"
      },
      {
         "chat_id": 2345,
         "number": "380672345678",
         "contact_id": 0,
         "name": "",
         "total_messages": 7,
         "unread_messages": 0,
         "last_message_date": "2022-10-02 16:14:41"
      }
   ]
}

Description of Response Parameter Values

Method sessions

Example request URL:
https://api.turbosms.ua/chat/sessions.json

This method returns an array of session data. Parameters can include either the chat ID in chat_id or the session ID in session_id. As an alternative to the chat_id parameter, you can use the sender_id or sender parameters to identify the sender, as well as the array of recipients recipients, for whom you want to receive data. The method also supports pagination parameters.

Example requests:

{
   "chat_id": 1234,
   "rows": 10
}

{
   "session_id": 123321
}

{
   "sender": "TurboSMS",
   "recipients": [
      "380678998668",
      "380503288668",
      "380638998668"
   ]
}

Example response:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": [
      {
         "id": 123456,
         "sender_id": 1,
         "sender": "TurboSMS",
         "recipient": 380678998668,
         "chat_id": 1234,
         "price": 0.88,
         "started": "2022-10-04 11:51:29",
         "ended": null,
         "sent_messages": 16,
         "unreplied_messages": 2
      },
      {
         "id": 123321,
         "sender_id": 1,
         "sender": "TurboSMS",
         "recipient": 380678998668,
         "chat_id": 1234,
         "price": 0.88,
         "started": "2022-10-03 09:12:41",
         "ended": "2022-10-04 09:12:41",
         "sent_messages": 31,
         "unreplied_messages": 0
      }
   ]
}

The response includes the session ID, sender and recipient details, cost of a session in the local currency (charged from the sender's or user's balance), start and end dates and times, as well as the number of sent and consecutively unreplied session messages. If the end time is null, the session is still active and session messages can be sent within it.

Method messages

Sample call address:
https://api.turbosms.ua/chat/messages.json

This method returns an array of chat messages. To retrieve the messages of a specific chat, you can pass its ID in the chat_id parameter, or use the alternative parameters sender_id or sender to identify the sender, as well as the array of recipients recipients for whom you want to receive data. This method also supports limiting the amount of data in the response with pagination, and messages are returned sorted by the time they were added, from newest to oldest. If the new_only parameter is specified, only unread messages will be returned; in this case, the pagination parameters are ignored, and the method returns all new messages of the specified chat. Please note that all unread messages returned by this method will automatically be marked as read by the system. If this behaviour is undesirable, pass the optional keep_unread parameter with the value 1 — the returned messages will then stay unread. You can also pass a message ID in the last_message_id parameter, in which case an array of messages following that ID will be returned, sorted from oldest to newest.

Request examples:

{
   "chat_id": 1234,
   "page": 2,
   "rows": 15
}

{
   "chat_id": 1234,
   "last_message_id": 1000
}

{
   "chat_id": 2345,
   "new_only": 1
}

{
   "chat_id": 2345,
   "new_only": 1,
   "keep_unread": 1
}

{
   "sender": "TurboSMS",
   "recipients": [
      "380678998668",
      "380503288668",
      "380638998668"
   ]
}

Sample response:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": [
      {
         "id": 1462,
         "sender_id": 1,
         "sender": "SuperShop",
         "recipient": 380678998668,
         "chat_id": 1234,
         "added": "2022-10-09 17:52:29",
         "type": "Inbox",
         "message_id": "",
         "message": "😍 Definitely yes",
         "message_type": "session",
         "status": "Read",
         "file_id": 0,
         "file_url": "",
         "file_name": "",
         "button_caption": "",
         "button_action": "",
         "replied_message_id": 1391,
         "replied_message": "Did you like the items sent in your last order?",
         "session_id": 123678
      },
      {
         "id": 1391,
         "sender_id": 1,
         "sender": "SuperShop",
         "recipient": 380678998668,
         "chat_id": 1234,
         "added": "2022-10-08 12:11:31",
         "type": "Outbox",
         "message_id": "50064123-6817-940a-892d-00c54b2bbac9",
         "message": "Did you like the items sent in your last order?",
         "message_type": "survey",
         "survey": [
            "😍 Definitely yes",
            "😊 More likely yes than no",
            "🙄 More likely not than yes",
            "😕 Definitely no",
            "🤬 This is my last order from you!"
         ],
         "status": "Read",
         "file_id": 0,
         "file_url": "",
         "file_name": "",
         "button_caption": "",
         "button_action": "",
         "replied_message_id": 0,
         "replied_message": "",
         "session_id": 0
      },
      {
         "id": 1373,
         "sender_id": 1,
         "sender": "SuperShop",
         "recipient": 380678998668,
         "chat_id": 1234,
         "added": "2022-10-03 09:18:52",
         "type": "Outbox",
         "message_id": "50064123-6817-940a-892d-ffc54b2bba51",
         "message": "Your order has been shipped, tracking number 1234567890",
         "message_type": "transactional",
         "status": "Read",
         "file_id": 0,
         "file_url": "",
         "file_name": "",
         "button_caption": "",
         "button_action": "",
         "replied_message_id": 0,
         "replied_message": "",
         "session_id": 123456
      },
      {
         "id": 1248,
         "sender_id": 1,
         "sender": "SuperShop",
         "recipient": 380678998668,
         "chat_id": 1234,
         "added": "2022-10-02 18:51:38",
         "type": "Inbox",
         "message_id": "",
         "message": "",
         "message_type": "session",
         "status": "Read",
         "file_id": 12387,
         "file_url": "https://turbosms.ua/user-files/f46/ce1/91b/123456.pdf",
         "file_name": "scan.pdf",
         "button_caption": "",
         "button_action": "",
         "replied_message_id": 1234,
         "replied_message": "The item is reserved, please download the invoice and send a scan of its payment.",
         "session_id": 123456
      },
      {
         "id": 1234,
         "sender_id": 1,
         "sender": "SuperShop",
         "recipient": 380678998668,
         "chat_id": 1234,
         "added": "2022-10-02 18:37:12",
         "type": "Outbox",
         "message_id": "50064123-6817-940a-892d-00c54b2bbac9",
         "message": "The item is reserved, please download the invoice and send a scan of its payment.",
         "message_type": "promotional",
         "status": "Read",
         "file_id": 0,
         "file_url": "",
         "file_name": "",
         "button_caption": "Download the invoice",
         "button_action": "https://turbosms.ua/user-files/f46/ce1/91b/123110.pdf",
         "replied_message_id": 0,
         "replied_message": "",
         "session_id": 0
      },
      {
         "id": 1234,
         "sender_id": 1,
         "sender": "SuperShop",
         "recipient": 380678998668,
         "chat_id": 1234,
         "added": "2022-10-01 11:57:49",
         "type": "Outbox",
         "message_id": "44064ac3-6817-940a-a97d-16c54b2b8a0f",
         "message_type": "carousel",
         "message": "You haven't ordered anything in a long time, we miss you and are giving you a 10% discount 🤗",
         "carousel": [
            {
              "image_url": "https://turbosms.ua/user-files/a67/71c/91b/1545256.jpg",
              "file_id": 13572,
              "title": "Bowl with avocado and salmon",
              "button_caption": "I want it!",
              "button_url": "https://super-shop.com/cart/add/bowl-avocado-salmon.html",
              "button_clicks": 12,
              "link_caption": "More details",
              "link_url": "https://super-shop.com/items/bowl-avocado-salmon.html",
              "link_clicks": 4
            },
            {
              "image_url": "https://turbosms.ua/user-files/4ba/fc5/91d/15223508.png",
              "file_id": 123456,
              "title": "Tempura vegetables with shrimp",
              "button_caption": "Or this!",
              "button_url": "https://super-shop.com/cart/add/birthday/tempura-vegetables-shrimps.html",
              "button_clicks": 17,
              "link_caption": "More details",
              "link_url": "https://super-shop.com/items/tempura-vegetables-shrimps.html",
              "link_clicks": 9
            },
            {
              "image_url": "https://turbosms.ua/user-files/f46/ce1/91b/123110.jpg",
              "file_id": 234567,
              "title": "Dragon Roll Platter",
              "button_caption": "Definitely",
              "button_url": "https://super-shop.com/cart/add/birthday/set-dragon-rolls.html",
              "button_clicks": 21,
              "link_caption": "More details",
              "link_url": "https://super-shop.com/items/set-dragon-rolls.html",
              "link_clicks": 5
            }
         ],
         "status": "Read",
         "file_id": 0,
         "file_url": "",
         "file_name": "",
         "button_caption": "",
         "button_action": "",
         "replied_message_id": 0,
         "replied_message": "",
         "session_id": 0
      }
   ]
}

Description of the Response Parameters

Method send

Example request URL:
https://api.turbosms.ua/chat/send.json

This method sends a session message to the chat specified in the chat_id parameter. As an alternative to the chat_id parameter, you can use the sender_id or sender parameters to identify the sender, as well as the phone number of the recipient in recipient to whom you want to send the message. Messages can contain either text in the message parameter or a file. The data scheme of the file can be passed in the file_data parameter, with the file_name parameter specifying the file name visible to the recipient. Alternatively, a file's URL can be provided in the file_url parameter instead of the data scheme.

Available parameters

Either chat_id or the pair of recipient and sender_id/sender must be present. Either message or file_name together with file_data or file_url must be present as well. The file name may contain up to 25 characters, the supported extensions are: .doc, .docx, .rtf, .dot, .dotx, .odt, .odf, .fodt, .txt, .pdf, .xps, .pdax, .eps, .xls, .xlsx, .ods, .fods, .csv, .xlsm, .xltx, .jpg, .jpeg, .png, .gif, .mp4, .sdocx.

Sending is only possible within an active session initiated by the recipient. No more than 5 messages in a row can be sent without a reply from the recipient; an attempt to send the sixth one returns the NOT_ALLOWED_SESSION_OUTBOX_LIMIT code.

Example requests:

{
   "chat_id": 1234,
   "message": "Your payment has been received. Please wait for shipping information."
}

{
   "sender": "Super Shop",
   "recipient": "380678998668",
   "message": "Your payment has been received. Please wait for shipping information."
}

{
   "chat_id": 1234,
   "file_name": "Presentation.pdf",
   "file_data": "data:application/pdf;base64,JVBERi0xLjMKJcTl8uXrp/Og0M....lRU9GCg=="
}

{
   "chat_id": 1234,
   "file_name": "Invoice.pdf",
   "file_url": "https://super-shop.com/invoices/12345.pdf"
}

Example response:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": {
      "message_id": 17693
   }
}

User Module

The module provides functionality for managing user account data.

Method balance

Example request URL:
https://api.turbosms.ua/user/balance.json

This method returns the user's account balance. The request body is empty.

Response structure:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": {
      "balance": 12345.67
   }
}

File Module

The module provides functionality for managing user files.

Method add

Example request URL:
https://api.turbosms.ua/file/add.json

This method allows uploading a file to our server. The file can be provided either as a URL, from which it will be downloaded, or directly in the request body in the data parameter. This parameter should contain the file content in data scheme format according to RFC 2397 (details). The data scheme can include the file content either as a base64 string or in an unencoded format.

Note that when sending a request via the GET method, you may encounter a URL length limitation of 2KB. To avoid this, send the request using the POST method when including the file in the data parameter.

Example requests:

{
   "url": "https://turbosms.ua/files/news/http-api.png"
}

{
   "data": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABIAAAASCAYAAABWzo5XAAAAwElEQVR4AayPMQ7CMBAET/keHSV1HkWRmgegUOZHlEgUkRU8ltY6WRjkxJE2d7f2Ti7D9TZvPTRYfC7nkx1RRFgC0RxVX9B7NXu+1l0iy9/03QhiqWmaDHmfGXlP/d+NFFRVsKxV0DiO+a6HeD9fiE0VFM+sDJUzd6SfIL8JgXLGk6ogH/KbeF8QahXEIRJEFe+bqiCCyIeYkffUJ1DYNLZXZROIeAiBYq01heIrg2LfDNFHySbQfX7Ysiy7RBbQBwAA//8FpsY7AAAABklEQVQDAFVE4hfSuaVLAAAAAElFTkSuQmCC"
}

Response structure:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": {
       "id": 32895,
       "link": "https://turbosms.ua/public/4ce/14a/c31/32895.png",
       "source": "https://turbosms.ua/files/news/http-api.png",
       "size": 12555,
       "created": "2021-01-21 18:00:09"
   }
}

The id value can be used in Viber campaigns. The link parameter contains a public link to the file, which can be accessed directly. The source parameter indicates the original file source specified during upload. The size parameter shows the file size in bytes, and the created parameter provides the date the file was saved to our server.

It is worth noting that when a file is uploaded, it is checked for duplicates. If the file has already been uploaded previously, the details of the existing file will be returned.

Method details

Sample call address:
https://api.turbosms.ua/file/details.json

This method returns file details for the passed id.

Sample request:

{
   "id": 32895
}

The response of this method is completely identical to the response of the file adding method.

Module patterns

The module provides work with message patterns that you can use to create messages without having to pass all the parameters in every request. Patterns also support variables for forming a personal text for a particular recipient. Only activated patterns can be used for sending messages; some pattern types do not require moderation and become available right after creation. You can find more information about creating patterns and their types in your account, in the sections for adding patterns.

Method create

Call address example:
https://api.turbosms.ua/patterns/create.json

This method creates a new pattern. Fields, limits and moderation rules are the same as in the pattern creation form in your account. The response returns the pattern id, which you can pass in the pattern_id parameter when sending messages, and the current status. You can also see the pattern id in your account, in the list of your patterns.

Request example:

{
   "name": "Confirmation code",
   "pattern_type": "transactional",
   "channel": "sms",
   "sender": "Magazin",
   "pattern": "Your login code is %1%",
   "example": "Your login code is 1234"
}

Request example for a survey pattern:

{
   "name": "Service survey",
   "pattern_type": "survey",
   "channel": "viber",
   "sender": "MyCompany",
   "pattern": "How do you like our service?",
   "survey": ["Excellent", "Fine", "Bad"]
}

Request example for a carousel pattern:

{
   "name": "Our products",
   "pattern_type": "carousel",
   "channel": "viber",
   "sender": "MyCompany",
   "pattern": "New arrivals",
   "carousel": [
      {
         "file_id": 32895,
         "title": "First product",
         "button_caption": "Buy",
         "button_url": "https://example.com/1"
      },
      {
         "file_id": 32896,
         "title": "Second product",
         "button_caption": "Buy",
         "button_url": "https://example.com/2"
      }
   ]
}

Response example:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": {
      "id": 1521,
      "status": "moderate"
   }
}

Request parameters description

Allowed values of the pattern_type parameter

Response parameters description

Method update

Call address example:
https://api.turbosms.ua/patterns/update.json

This method updates the data of an existing pattern. The pattern_id parameter is required, the other parameters are the same as in the create method; pass only the parameters whose values you need to change. Survey answer options and carousel items are overwritten entirely. An activated transactional Viber pattern cannot be edited. When editing a pattern whose type requires moderation, its status changes to moderate.

Request example:

{
   "pattern_id": 1521,
   "name": "Confirmation code",
   "pattern_type": "transactional",
   "channel": "sms",
   "pattern": "Your new login code is %1%",
   "example": "Your new login code is 1234",
   "sender": "Magazin"
}

Response example:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": null
}

Method delete

Call address example:
https://api.turbosms.ua/patterns/delete.json

The method deletes a pattern together with all related data (survey answer options, carousel items, etc.). An activated transactional Viber pattern cannot be deleted. If you need to delete such a pattern, please contact our customer support.

Request example:

{
   "pattern_id": 1521
}

Response example:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": null
}

Method list

Call address example:
https://api.turbosms.ua/patterns/list.json

The method returns patterns with all details. Without pagination parameters, the 50 most recently added patterns are returned. If a pattern has not passed moderation or needs to be revised, the moderator_info field contains the moderator's comment in the pattern language (the lang parameter), or in Ukrainian if no language is specified.

Request example:

{
   "status": "approved",
   "channel": "viber",
   "pattern_type": "transactional",
   "page": 1,
   "rows": 20
}

Response example:

{
   "response_code": 0,
   "response_status": "OK",
   "response_result": {
      "items": [
         {
            "id": 1521,
            "name": "Confirmation code",
            "pattern_type": "transactional",
            "channel": "viber",
            "status": "approved",
            "moderator_info": "",
            "pattern": "Your login code is %1%",
            "example": "Your login code is 1234",
            "sender": "MyCompany",
            "caption": "",
            "action": "",
            "file_id": null,
            "image_only": 0,
            "lang": "ru",
            "created_at": "2026-08-13 12:00:00",
            "updated_at": "2026-08-13 12:00:00"
         }
      ],
      "total": 1,
      "page": 1,
      "rows": 20
   }
}

Request parameters description

Response parameters description

Possible pattern statuses

Description of Request Processing Result Codes