API SMS-шлюза

Интеграция SMS-сообщений в ваши продукты

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

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

Описание API
Мы разработали API, которые разработчики могут использовать в своих продуктах для взаимодействия с SMS-шлюзом SMS Aero.
Как это работает?
Тип ответа
По умолчанию сервис возвращает ответ типа plain/text. При указании дополнительного параметра &answer=json сервис возвращает массив типа json.
GET или POST запрос на сервер, вида:
http://gate.smsaero.ru/balance/?answer=json
или
https://gate.smsaero.ru/balance/?answer=json
При успешной авторизации, в ответ сервис должен вернуть json-массив вида:
{"balance":"12345"}

где цифра, это количество доступных SMS на балансе.

Передача сообщения
GET или POST запрос на сервер, вида:
http://gate.smsaero.ru/send/?to=71234567890&text=test
или
https://gate.smsaero.ru/send/?to=71234567890&text=test
ПараметрСтатусОписание
userОбязательноЛогин в системе
passwordОбязательноПароль (md5)
toОбязательноНомер телефона получателя, в формате 71234567890
textОбязательноТекст сообщения, в UTF-8 кодировке
fromОбязательноПодпись отправителя (например TEST)
from2Не обязательноПодпись отправителя для оператора Мегафон (только цифровая подпись в формате 71234567890). Если параметр не указан, то для абонентов сети Мегафон будет проставлена служебная цифровая подпись, используемая системой SMS Aero по-умолчанию или подпись заданная в вашем личном кабинете, если она указанна.
dateНе обязательноДата для отложенной отправки сообщения (количество секунд с 1 января 1970 года)
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
123456=accepted
ПараметрОписание
acceptedСообщение принято сервисом
empty field. rejectНе все обязательные поля заполнены
incorrect user or password. rejectОшибка авторизации
no creditsНедостаточно sms на балансе
incorrect sender name. rejectНеверная (незарегистрированная) подпись отправителя
incorrect destination adress. rejectНеверно задан номер телефона (формат 71234567890)
incorrect date. rejectНеправильный формат даты
in blacklist. rejectТелефон находится в черном списке
Проверка состояния отправленного сообщения
GET или POST запрос на сервер, вида:
http://gate.smsaero.ru/status/?id=123456
или
https://gate.smsaero.ru/status/?id=123456
ПараметрСтатусОписание
userОбязательноЛогин в системе
passwordОбязательноПароль (md5)
idОбязательноИдентификатор сообщения, который вернул сервис при отправке сообщения
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
123456=delivery success
ПараметрОписание
delivery successСообщение доставлено
delivery failureОшибка доставки SMS (абонент в течение времени доставки находился вне зоны действия сети или номер абонента заблокирован)
smsc submitСообщение доставлено в SMSC
smsc rejectотвергнуто SMSC
queueОжидает отправки
wait statusОжидание статуса (запросите позднее)
incorrect id. rejectНеверный идентификатор сообщения
empty field. rejectНе все обязательные поля заполнены
incorrect user or password. rejectОшибка авторизации
Проверка состояния счета
GET или POST запрос на сервер, вида:
http://gate.smsaero.ru/balance/
или
https://gate.smsaero.ru/balance/
ПараметрСтатусОписание
userОбязательноЛогин в системе
passwordОбязательноПароль (md5)
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
balance=12345

где цифра, это количество доступных SMS на балансе.

Список доступных подписей отправителя
GET или POST запрос на сервер, вида:
http://gate.smsaero.ru/senders/
или
https://gate.smsaero.ru/senders/
ПараметрСтатусОписание
userОбязательноЛогин в системе
passwordОбязательноПароль (md5)
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
Sender_oneSender_twoSender_three

где выводится список доступных подписей по одной в каждой строке.

Запрос новой подписи
GET или POST запрос на сервер, вида:
http://gate.smsaero.ru/sign/?sign=example
или
https://gate.smsaero.ru/sign/?sign=example
ПараметрСтатусОписание
userОбязательноЛогин в системе
passwordОбязательноПароль (md5)
signОбязательноИмя подписи
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
accepted=status

Возможные значения status:

ПараметрСтатусОписание
approvedПодпись принята
rejectedПодпись отклонена
pendingПодпись ожидает подтверждения
8 800 555 7 550