SendSMS

Метод SendSMS

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

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

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

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

Авторизация

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

Имя Тип Описание
Authorization string API-ключ приложения с Bearer перед ним. Пример: Bearer e***s0, где e***s0 замените на API-ключ вашего приложения

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

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

Параметр Тип Описание
number string номер отправителя / имя отправителя (альфа-имя)
destination string номер получателя
text string текст сообщения

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

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

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

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

Параметр Тип Описание
message_id string идентификатор сообщения
template_resource_id uint64 идентификатор шаблона, указывается при отправке шаблонированного SMS

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

Код Статус Пример сообщения Описание
404 Not Found page not found некорректно введен URL-адрес запроса
401 Unauthorized authorization token is invalid неправильно указан токен (API-ключ приложения)
400 Bad Request unknown field невалидный параметр
400 Bad Request text does not match the template текст сообщения не соответствует указанному при отправке шаблону
400 Bad Request syntax error синтаксическая ошибка
400 Bad Request invalid value невалидное значение в параметре
400 Bad Request fail to get number info/number does not belong to the client номер не принадлежит пользователю
400 Bad Request exceeded the limit of segments sms (maximum 10) превышено количество сегментов в сообщении, максимум — 10 сегментов
400 Bad Request destination is not permitted for delivery отправка сообщения с неактивированного аккаунта на неподтверждённый номер
400 Bad Request incorrect customer status нет доступа к отправке сообщений, т.к. аккаунт не активирован или заблокирован

Примеры

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

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

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

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

Содержание статьи