REST ИНТЕРФЕЙС

• Передача сообщения
• Проверка состояния сообщения
• Проверка очереди статусов сообщений
• Проверка состояния счета
• Список доступных подписей отправителя

Передача сообщения

GET запрос на сервер, вида:

https://api.iqsms.ru/messages/v2/send/?phone=%2B71234567890&text=test

Параметр	Статус	Описание
login	Обязательно	Логин (на выбор: GET параметр или basic access authentication)
password	Обязательно	Пароль (на выбор: GET параметр или basic access authentication)
phone	Обязательно	Номер телефона, в формате +71234567890
text	Обязательно	Текст сообщения, в UTF-8 кодировке
wapurl		Wap-push ссылка, в случае, если вы хотите передать wap-push сообщение (например wap.yousite.ru)
sender		Подпись отправителя (например TEST)
flash		Flash SMS – сообщение, которое сразу отображается на экране и не сохраняется в памяти телефона (1 – активировано)
scheduleTime		Дата для отложенной отправки сообщения, в UTC (2009-01-01T12:30:01+00:00)
statusQueueName		Название очереди статусов отправленных сообщений, в случае, если вы хотите использовать очередь статусов отправленных сообщений. От 3 до 16 символов, буквы и цифры (например myQueue1)

При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:

accepted;A132571BC

где до знака «;» сервис выдает ответ сервиса о статусе сообщения, а после знака «;» идентификатор сообщения (A-F 0-9, макс. 72 симв.)

Параметр	Описание
accepted	Сообщение принято сервисом
invalid mobile phone	Неверно задан номер тефона (формат 71234567890)
text is empty	Отсутствует текст
sender address invalid	Неверная (незарегистрированная) подпись отправителя
wapurl invalid	Неправильный формат wap-push ссылки
invalid schedule time format	Неверный формат даты отложенной отправки сообщения
invalid status queue name	Неверное название очереди статусов сообщений
not enough credits	Баланс пуст (проверьте баланс)

Проверка состояния отправленного сообщения (до 200 id в запросе)

GET запрос на сервер, вида:

https://api.iqsms.ru/messages/v2/status/?id=A132571BC&id=A132571BD&id=A132571BE

Параметр	Статус	Описание
login	Обязательно	Логин (на выбор: GET параметр или basic access authentication)
password	Обязательно	Пароль (на выбор: GET параметр или basic access authentication)
id	Обязательно	Идентификатор сообщения, который вернул сервис при отправке сообщения

При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:

A132571BC;delivered

где в каждой строке до запятой id запрашиваемого статуса, а после запятой ответ сервиса о статусе сообщения:

Параметр	Описание
queued	Сообщение находится в очереди
delivered	Сообщение доставлено
delivery error	Ошибка доставки SMS (абонент в течение времени доставки находился вне зоны действия сети или номер абонента заблокирован)
smsc submit	Сообщение доставлено в SMSC
smsc reject	Сообщение отвергнуто SMSC (номер заблокирован или не существует)
incorrect id	Неверный идентификатор сообщения

Проверка очереди статусов отправленных сообщений

GET запрос на сервер, вида:

https://api.iqsms.ru/messages/v2/statusQueue/?statusQueueName=myQueue1&limit=5

Параметр	Статус	Описание
login	Обязательно	Логин (на выбор: GET параметр или basic access authentication)
password	Обязательно	Пароль (на выбор: GET параметр или basic access authentication)
statusQueueName	Обязательно	Название очереди статусов сообщений. Название очереди устанавливается при передаче сообщения
limit		Количество запрашиваемых статусов из очереди (по умолчанию 1, макс. 1000)

При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:

A132571BC;smsc submit
A132571BC;delivered
A13257316;smsc submit
A1325753A;delivery error
A13257316;delivered

где сервис возвращает по одному статусу в каждой строке (подробнее о статусах)

Параметр	Описание
queue is empty	Очередь пуста
absent status queue name	Не указано название очереди статусов сообщений
invalid status queue name	Неверно указано название очереди статусов сообщений

Проверка состояния счета

GET запрос на сервер, вида:

https://api.iqsms.ru/messages/v2/balance/

Параметр	Статус	Описание
login	Обязательно	Логин (на выбор: GET параметр или basic access authentication)
password	Обязательно	Пароль (на выбор: GET параметр или basic access authentication)

При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:

RUB;540.15

где в каждой строке 1 значение – тип баланса, 2 значение – баланс.

Список доступных подписей отправителя

GET запрос на сервер, вида:

https://api.iqsms.ru/messages/v2/senders/

Параметр	Статус	Описание
login	Обязательно	Логин (на выбор: GET параметр или basic access authentication)
password	Обязательно	Пароль (на выбор: GET параметр или basic access authentication)

При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:

Sender_one
Sender_two
Sender_three

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