SMS API

SMS API позволяет отправлять и получать SMS-сообщения, а также получать отчёты о доставке и статистические данные. Решение легко интегрируется в любые бизнес-системы и подходит для уведомлений, подтверждений операций и маркетинговых рассылок.

SMS можно отправлять не только с использованием мобильного номера, но и от индивидуального имени, отражающего название компании. Отправка от согласованного операторами имени обеспечивает максимальную гарантию доставки сообщений и позволяет запускать шаблонные рассылки с кодами подтверждения, уведомлениями о доставке и финансовых операциях.

Методы SMS API Exolve для работы:

• SendSMS — отправляет SMS-сообщение;
• SendMessage — отправляет cообщение в различные каналы связи (в данный момент доступен канал Telegram Verify);
• GetList — получает данные об отправленных и полученных SMS-сообщениях;
• GetCount — получает количество отправленных и полученных SMS-сообщений по заданным параметрам;
• GetAlphaNames — получает список зарегистрированных имён отправителей;
• CreateTemplate — создаёт шаблон для авторизационных, сервисных или транзакционных SMS и отправляет его на согласование операторам;
• GetTemplate - получает информацию об одном SMS-шаблоне;
• GetTemplates - получает информацию обо всех SMS-шаблонах.

Решения, где используется SMS API

SMS-рассылки

SMS-рассылки по своей базе

SMS-шлюз

Попробовать бесплатно

Метод SendSMS

Примените этот метод для отправки SMS-сообщения c мобильного номера телефона или от имени отправителя (альфа-имени). Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Примечание
Отправка SMS с городских (ABC) или с федеральных номеров 8-800 невозможна, а доставка рассылок с мобильных номеров не гарантирована операторами. Сообщения с максимальной вероятностью будут доставлены, если отправлять их от индивидуального буквенного или буквенно-цифрового имени. Такое имя отправителя могут зарегистрировать только юрлица и ИП. Узнать подробнее можно здесь.

Точка подключения:

POST: https://api.exolve.ru/messaging/v1/SendSMS

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Примечание
С помощью имени отправителя возможно отправлять не только рекламные, но и шаблонированные SMS. Они поддерживают переменные — можно обратиться к клиенту по имени, сообщить номер заказа или сумму покупки. Такие сообщения стоят дешевле, чем рекламные. Узнать подробнее о шаблонах можно здесь

Для отправки шаблонированного SMS не нужно указывать идентификатор шаблона. Подходящий шаблон будет найден и использован во время отправки при условии согласования операторами и соответствия текста SMS шаблону. В выходных параметрах в таком случае будет указан идентификатор использованного шаблона.

Требования к оформлению шаблонов можно посмотреть здесь.

Во время тестового периода текст отправленного SMS (параметр text) автоматически меняется на «Это тестовое SMS от МТС Exolve. Подпишите договор, чтобы изменить текст на свой». Какие есть ограничения на тестовом аккаунте можно посмотреть здесь.

Выходные параметры

Возможные ошибки

Примеры

Входные параметры:

{
    "number": "79991112233",
    "destination": "79992223344",
    "text": "Test message"
}

Выходные параметры:

{
    "message_id": "439166538239448536",
    "template_resource_id": 136519
}

Метод GetCount

Примените этот метод для получения числа SMS-сообщений по заданным параметрам. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/messaging/v1/GetCount

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Можно передать пустой запрос — тогда вы получите число всех SMS этого приложения без применения фильтров поиска.

Direction

BillingStatus

DeliveryStatus

Status

Channel

CategoryType

Выходные параметры

Возможные ошибки

Примеры

Входные параметры:

{
    "message_id": "444067567615608452",
    "limit": "10000",
    "offset": "0",
    "number": "79678880033",
    "direction": 2,
    "delivery_status": 3,
    "billing_status": 2,
    "status": 3,
    "channel": 1,
    "date_gte":"2023-01-20T11:30:01.335Z",
    "date_lte":"2023-01-20T11:39:01.335Z",
    "date_sent_received_gte":"2023-01-20T11:30:01.335Z",
    "date_sent_received_lte":"2023-01-20T11:39:01.335Z",
    "price_gte": 1.5,
    "price_lte": 10.12,
}

Выходные параметры:

{
    "count": "1"
}

Метод GetList

Примените метод GetList, чтобы получить информацию об исходящих и входящих сообщениях по заданным параметрам.

Точка подключения: Выполните POST-запрос с входными параметрами к точке подключения:

POST: https://api.exolve.ru/messaging/v1/GetList

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Можно передать пустой запрос — тогда вы получите информацию обо всех SMS этого приложения без применения фильтров поиска.

MCC/MNC коды оператора

• MCC (Mobile Country Code) — код страны, в которой находится оператор мобильной связи. Состоит из 3 цифр.
• MNC (Mobile Network Code) — код мобильной сети (оператора), следует после MCC. Состоит из 2 или 3 цифр, уникален для каждого оператора он уникален.

Комбинация MCC + MNC + наименование оператора позволяет однозначно определить сеть. Эти коды унифицированы — вы можете воспользоваться любым справочником, чтобы найти нужный код.

Channel

CategoryType

SortOrder

OrderByDate/OrderBySegmentsCount

Выходные параметры

Direction

BillingStatus

DeliveryStatus

Status

Channel

CategoryType

Примеры

Входные параметры (для SMS и УПН → SMS):

{
   "message_id": 535103102366598674,
   "limit": 100,
   "offset": 0,
   "number": "79813330013",
   "sender": "79813340013",
   "direction": 2,
   "delivery_status": 3,
   "billing_status": 2,
   "status": 3,
   "date_gte": "2024-10-01T10:00:56.759Z",
   "date_lte": "2024-12-10T10:00:56.759Z",
   "date_sent_received_gte":"2023-01-20T11:30:01.335Z",
   "date_sent_received_lte":"2023-01-20T11:39:01.335Z",
   "receiver": "79873558880",
   "receiver_mcc": "250",
   "receiver_mnc": "1",
   "receiver_mobile_operator": "MTS",
   "category": 1,
   "campaign_id": "12345",
   "campaign_name": "test",
   "sort": {
       "order_by_date": 1
   },
   "price_gte": 1.5,
   "price_lte": 10.12,
}

Входные параметры (для Telegram Verify):

{
   "message_id": 582622948376971821,
   "limit": 100,
   "offset": 0,
   "delivery_status": 3,
   "billing_status": 2,
   "status": 3,
   "date_gte": "2025-09-02T06:00:03Z",
   "date_lte": "2025-09-02T08:00:03Z",
   "sort": {
       "order_by_date": 1
   }
}

Выходные параметры (для SMS и УПН → SMS):

{
   "messages": [
       {
           "message_id": "535103152366598674",
           "application_uuid": "6cb49297-8cd2-4f34-8e8b-856679a82437",
           "date": "2024-10-09T12:12:18.303Z",
           "date_sent_received": "2024-10-09T12:12:18.303Z",
           "number": "79813330013",
           "sender": "79813340013",
           "receiver": "79873558880",
           "text": "МТС Exolve — конструктор омниканальных диалогов для бизнеса",
           "direction": 2,
           "segments_count": 1,
           "billing_status": 2,
           "delivery_status": 3,
           "channel": 1,
           "status": 3,
           "sender_mcc": "250",
           "sender_mnc": "42",
           "sender_mobile_operator": "MTT",
           "receiver_mcc": "250",
           "receiver_mnc": "1",
           "receiver_mobile_operator": "MTS",
           "campaign_id": "12345",
           "campaign_name": "test",
           "category": 1,
           "price": 1.5
       }
   ]
}

Выходные параметры (для Telegram Verify):

{
    "message_id": "582622948376971821",
    "application_uuid": "6cb49297-8cd2-4f34-8e8b-856679a82437",
    "date": "2025-09-02T07:59:03Z",
    "receiver": "79873558881",
    "text": "1234",
    "direction": 2,
    "segments_count": 1,
    "billing_status": 2,
    "delivery_status": 3,
    "channel": 4,
    "status": 3,
    "date_sent_received": "2025-09-02T07:58:58.823Z"
}

Возможные ошибки

Метод GetAlphaNames

Примените этот метод для получения списка созданных имен отправителя (альфа-имен). Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/messaging/v1/GetAlphaNames

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте пустой JSON.

Выходные параметры

AlphaName

AlphaNameStatus

AlphaNameOperator

Operator

ApprovalStatus

Пример

Входные параметры:

{}

Выходные параметры:

{
    "alpha_names": [
        {
            "resource_id": "113441",
            "name": "Test1",
            "status": 2, // неактивно
            "operators": [
                {
                    "operator": 1, // МТС
                    "status": 1 // на согласовании
                }
            ]
        },
        {
            "resource_id": "113440",
            "name": "Test2",
            "status": 1, // активно
            "operators": [
                {
                    "operator": 1, // МТС
                    "status": 2, // согласовано 
                    "subscription_fee": 2500
                },
                {
                    "operator": 2, // Мегафон
                    "status": 3 // отклонено
                }
            ],
            "activation_date": "2023-07-25T12:56:48.890632Z"
        }
   ]
}

Метод CreateTemplate

Примените этот метод для создания SMS-шаблона. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/messaging/v1/CreateTemplate

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

TemplateCategory

CategoryType

Operators

Соотношение категорий к операторам

Для каждого оператора можно выбрать только одну категорию:

• Авторизационные SMS содержат коды, пароли, логины и т.д.
• Сервисные SMS уведомляют о доставке товара, напоминают о предстоящих мероприятиях или сообщают о результатах рассмотрения обращений
• Транзакционные SMS используются для информирования пользователей об операциях с денежными средствами, либо о невозможности выполнения такой операции

Подробнее о требованиях к шаблонам можно прочитать здесь.

Выходные параметры

Примеры

Входные параметры:

{
    "alpha_name": "SHOP",
    "template_name": "Доставка заказа",
    "template_text": "Заказ: %w{1,3} на сумму %d руб. Доставит курьер %w. Дата доставки: %w{1,2} с %d по %d",
    "example_text": "Заказ: 1234 на сумму 1000 руб. Доставит курьер Олег. Дата доставки: 12 мая с 15:00 по 20:00",
    "template_category": [
        {
            "template_category_type": 2, // сервисная
            "operators": [
                1, 3 // МТС, Билайн
            ]
        },
        {
            "template_category_type": 1, // авторизационная
            "operators": [
                2 // МегаФон
            ]
        }
    ]
}

Выходные параметры:

{
    "template_resource_id": 132637
}

Метод GetTemplate

Примените этот метод для получения информации об SMS-шаблоне. Для этого выполните POST-запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/messaging/v1/GetTemplate

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие параметры в теле запроса в JSON-формате. Параметры, отмеченные жирным шрифтом, являются обязательными.

Выходные параметры

Template

TemplateOperators

Operator

Status

Category

TemplateHistory

Примеры

Входные параметры:

{
    "template_resource_id": "132680"
}

Выходные параметры:

{
    "template": {
        "resource_id": "132680",
        "template_name": "Заказ принят",
        "template_text": "Заказ: %w{1,n} %d на сумму %d руб принят. Планируемое время отгрузки в пункт выдачи: %d в интервале %d.",
        "example_text": "Заказ: SV TRT 860700 на сумму 7700 руб принят. Планируемое время отгрузки в пункт выдачи: 07.11.19 в интервале 17:00-20:00.",
        "alpha_name": "SHOP",
        "alpha_name_resource_id": "132669",
        "operators": [
            {
                "operator": 1,
                "status": 1,
                "template_category": 1
            }
        ],
        "history": [
            {
                "action": "МТС изменил статус на На согласовании",
                "status": 1,
                "action_date": "2023-10-30T16:36:36Z",
                "comment": ""
            }
        ],
        "creation_date": "2023-10-30T16:36:32.671312Z"
    }
}

Метод GetTemplates

Примените этот метод для получения информации обо всех SMS-шаблонах приложения. Для этого выполните POST запрос с входными параметрами к точке подключения, указанными ниже.

Точка подключения:

POST: https://api.exolve.ru/messaging/v1/GetTemplates

Авторизация

Передайте следующие Заголовки HTTP для успешной авторизации.

Входные параметры

Передайте следующие необязательные параметры в теле запроса в JSON-формате.

Выходные параметры

Templates

TemplateOperators

Operator

Status

Category

Примеры

Входные параметры:

{
    "alpha_name": "SHOP"
}

Выходные параметры:

{
    "templates":[ 
        {
            "resource_id": 132680,
            "template_name": "Заказ принят",
            "template_text": "Заказ: %w{1,n} %d на сумму %d руб принят. Планируемое время отгрузки в пункт выдачи: %d в интервале %d.",
            "alpha_name": "SHOP",
            "alpha_name_resource_id": 132669,
            "operators": [
                {
                    "operator": 1,
                    "status": 1,
                    "template_category": 1
                }
            ],
            "creation_date": "2023-10-30T16:36:32.671312Z"
        },
        {
            "resource_id": 132683,
            "template_name": "Доставка заказа",
            "template_text": "Заказ: %w{1,3} на сумму %d руб. Доставит курьер %w. Дата доставки: %w{1,2} с %d по %d",
            "alpha_name": "SHOP",
            "alpha_name_resource_id": 132669,
            "operators": [
                {
                    "operator": 2,
                    "status": 1,
                    "template_category": 3
                },
                {
                    "operator": 3,
                    "status": 1,
                    "template_category": 3
                }
            ],
            "creation_date": "2023-10-30T16:36:32.671312Z"
        },
    ]
}

Параметры уведомлений о входящих и исходящих сообщениях

Direction

DeliveryStatus

Status

MessageChannel

Примеры

Исходящие сообщения

{
            "event_id": "449727651343549249",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.040913196Z",
            "sender": "79999999999",
            "receiver": "79133333333",
            "text": "Test events",
            "direction": "DIRECTION_OUTGOING",
            "segments_count": 1,
            "delivery_status": "DELIVERY_STATUS_QUEUED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_QUEUED"
}
{
            "event_id": "449727651460989761",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:49.113153506Z",
            "sender": "79999999999",
            "receiver": "79133333333",
            "text": "Test events",
            "direction": "DIRECTION_OUTGOING",
            "segments_count": 1,
            "delivery_status": "DELIVERY_STATUS_TRANSMITTED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_TRANSMITTED"
}
{
            "event_id": "449727659866374977",
            "message_id": "449727651326723744",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:54.117363454Z",
            "sender": "79999999999",
            "receiver": "79133333333",
            "text": "Test events",
            "direction": "DIRECTION_OUTGOING",
            "segments_count": 1,
            "delivery_status": "DELIVERY_STATUS_DELIVERED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_DELIVERED"
}

Входящие сообщения

{
            "event_id": "449727660168364865",
            "message_id": "449727659849588395",
            "application_id": "74caefbc-5615-49db-aca1-07ba829e728c",
            "date": "2023-02-28T12:42:54.298316597Z",
            "sender": "79133333333",
            "receiver": "79999999999",
            "text": "Test events",
            "direction": "DIRECTION_INCOMING",
            "segments_count": 1,
            "delivery_status": "DELIVERY_STATUS_DELIVERED",
            "message_channel": "MESSAGE_CHANNEL_SMS",
            "status": "STATUS_DELIVERED"
}

Решения, где используется SMS API

SMS-рассылки на <<Мегафон>>

Рекламные SMS-рассылки

Сервисные и транзакционные SMS-рассылки

Попробовать бесплатно