Метод для простой отправки одного SMS-сообщения одному или нескольким адресатам.
Максимальное количество номеров для отправки SMS — 150 за вызов.
Ограничение по количеству запросов от одного API-ключа или IP-адреса — 300 запросов/60 секунд.
Принцип использования
| Синтаксис и URL для вызова метода |
| sendSms (string phone, string sender, string text) |
| Пример с одним телефоном:
https://api.unisender.com/ru/api/sendSms?format=json&api_key=KEY&phone=TO&sender=FROM&text=TEXT |
| Пример с несколькими телефонами:
https://api.unisender.com/ru/api/sendSms?format=json&api_key=KEY&phone=PHONE1,PHONE2&sender=FROM&text=TEXT |
| Аргументы | |
| api_key * | Ключ доступа к API. |
| phone * | Телефон получателя в международном формате с кодом страны (можно опускать ведущий «+»).
Пример: phone=79092020303 Можно указывать несколько номеров адресатов через запятую. Максимальное количество номеров за один вызов: 150. Пример: phone=79092020303,79002239878 |
| sender * | Отправитель – зарегистрированное имя отправителя (альфа-имя). Строка может содержать от 3 до 11 латинских букв или цифр с буквами. Также возможны специальные символы – точка, дефис, тире и некоторые другие.
Важно! Для отправки SMS-сообщения альфа-имя должно быть зарегистрированным, согласно процедуре. Пример: sender=MyCompany |
| text * | Текст сообщения, до 1000 символов. Символы подстановки типа игнорируются.
Пример: text=Hello,+it's+a+test+message text=SMS-%D1%81%D0%BE%D0%BE%D0%B1%D1%89% D0%B5%D0%BD%D0%B8%D0%B5%2C |
| Возвращаемое значение | |
| В случае отправки на один номер возвращаемым значением является JSON-объект. Если указано несколько телефонов, то возвращаемым значением является массив JSON-объектов. Поля, составляющие JSON-объект: | |
| currency | Трёхбуквенный международный код валюты, в которой посчитана цена сообщения. Валюта совпадает с валютой вашего счёта (RUB, BYN). |
| price | Цена в валюте currency, число с десятичной точкой. |
| sms_id | Уникальный цифровой код сообщения. Может использоваться для контроля доставки методом checkSms. |
При вызове данного метода возможно возвращение специфичных для него кодов ошибок:
| Коды ошибок | |
| dest_invalid | Доставка невозможна, телефон получателя некорректен. |
| src_invalid | Доставка невозможна, аргумент sender (поле «отправитель») некорректен. |
| invalid_arg | Доставка невозможна, аргумент sender некорректен (альфа-имя отправителя не зарегистрировано). |
| has_been_sent | SMS данному адресату уже был отправлен. Допустимый интервал между двумя отправками - 1 минута. |
| unsubscribed_globally | Адресат глобально отписан от рассылок. |
Пример формирования URL-запроса
https://api.unisender.com/ru/api/sendSms?format=json&api_key=KEY &phone=79998887766&sender=MyCompany&text=Hello,+World!
— отправить сообщение Hello, World на номер +7999887766 с указанием имени отправителя MyCompany.
