Метод 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 шаблону. В выходных параметрах в таком случае будет указан идентификатор использованного шаблона.
Требования к оформлению шаблонов можно посмотреть здесь.
Во время тестового периода текст отправленного SMS (параметр text) автоматически меняется на «Это тестовое SMS от МТС Exolve. Подпишите договор, чтобы изменить текст на свой». Какие есть ограничения на тестовом аккаунте можно посмотреть здесь.
Выходные параметры
| Параметр | Тип | Описание |
|---|---|---|
| message_id | string | идентификатор сообщения |
| template_resource_id | uint64 | идентификатор шаблона, указывается при отправке шаблонированного SMS |
Возможные ошибки
| Код | Статус | Пример сообщения | Описание |
|---|---|---|---|
| 400 | Bad Request | unknown field | недопустимый параметр |
| 400 | Bad Request | syntax error | синтаксическая ошибка в запросе |
| 400 | Bad Request | invalid value | некорректное значение параметра |
| 400 | Bad Request | incorrect customer status | нет доступа к отправке сообщений, т.к. аккаунт не активирован или заблокирован |
| 400 | Bad Request | exceeded the limit of segments sms (maximum 10) | превышено макс. количество сегментов sms (10) |
| 400 | Bad Request | failed to get alpha_name info | ошибка получения информации об имени отправителя |
| 400 | Bad Request | fail to get number info/number does not belong to the client | номер не принадлежит пользователю |
| 400 | Bad Request | failed to get customer state | ошибка получения информации о клиенте |
| 400 | Bad Request | incorrect source | ошибка получения номера отправителя |
| 400 | Bad Request | destination is not permitted for delivery | номер получателя не разрешен для отправки сообщения |
| 400 | Bad Request | alpha name is not active | имя отправителя неактивно |
| 400 | Bad Request | can’t send message to this number. Failed to get hlr number info | ошибка получения информации о номере получателя |
| 400 | Bad Request | can’t send message to this number. Forbidden number operator | оператор получателя не согласован для имени отправителя |
| 400 | Bad Request | fail to get template info | ошибка получения информации об указанном шаблоне |
| 400 | Bad Request | Cannot send template SMS from this alpha name. Template does not belong to this alpha name | указанный шаблон не согласован для имени отправителя |
| 400 | Bad Request | Forbidden SMS sending. Destination operator not approved for template. | оператор получателя не согласован для указанного шаблона |
| 400 | Bad Request | text does not match the template | текст сообщения не соответствует указанному шаблону |
| 400 | Bad Request | Сannot send template SMS not with an alpha name" | отправить шаблонное сообщение можно только от имени отправителя |
| 401 | Unauthorized | authorization token is invalid | неверный api-токен авторизации |
| 403 | Forbidden | incorrect customer state | аккаунт не активирован или заблокирован |
| 404 | Not Found | page not found | некорректно введен URL-адрес запроса |
| 404 | Not Found | alpha_name not found | имя отправителя не найдено |
| 404 | Not Found | source number not found/not found source | номер отправителя не найден |
| 404 | Not Found | customer not found | данные клиента не найдены |
| 404 | Not Found | can’t send message to this number. Number does not exist | ошибка получения информации о номере получателя |
| 404 | Not Found | template not found | ошибка получения информации об указанном шаблоне |
| 500 | InternalServerError | Fail to send sms started | ошибка при попытке отправки сообщения |
| 504 | GatewayTimeout | alpha name api request timed out after 5 seconds/number api request timed out after 5 seconds | превышено время ожидания ответа (5 секунд) |
Примеры
Входные параметры:
{
"number": "79991112233",
"destination": "79992223344",
"text": "Test message"
}
Выходные параметры:
{
"message_id": "439166538239448536",
"template_resource_id": 136519
}