MESSAGES REST V2

Передача сообщения Проверка состояния отправленного сообщения (до 200 id в запросе) Проверка очереди статусов отправленных сообщений Проверка состояния счета Список доступных подписей отправителя Проверка активной версии API

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

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

http://apisms.expecto.me/messages/v2/send/?phone=%2B71234567890&text=test

Параметр Описание

login ✔ Логин (на выбор: GET параметр или basic access authentication)

password ✔ Пароль (на выбор: GET параметр или basic access authentication)

phone ✔ Номер телефона, в формате +71234567890

text ✔ Текст сообщения, в UTF-8 кодировке

sender Подпись отправителя (например TEST)

scheduleTime Дата для отложенной отправки сообщения, в UTC (2008-07-12T14:30:01Z)

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 Неверное название очереди статусов сообщений

Страница 1 MESSAGES REST V2

not enough balance Баланс пуст (проверьте баланс)

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

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

http://apisms.expecto.me/messages/v2/status/?id=A132571BC&id=A132571BD&id=A132571BE

Параметр Описание

login ✔ Логин (на выбор: GET параметр или basic access authentication)

password ✔ Пароль (на выбор: GET параметр или basic access authentication)

id ✔ Идентификатор сообщения, который вернул сервис при отправке сообщения

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

A132571BC;delivered A132571BD;smsc submit A132571BE;queued

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

Параметр/значение Описание

queued Сообщение находится в очереди

delivered Сообщение доставлено

delivery error Ошибка доставки SMS (абонент в течение времени доставки находился вне зоны

действия сети или номер абонента заблокирован)

smsc submit Сообщение доставлено в SMSC

smsc reject Сообщение отвергнуто SMSC (номер заблокирован или не существует)

incorrect id Неверный идентификатор сообщения

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

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

http://apisms.expecto.me/messages/v2/statusQueue/?statusQueueName=myQueue1&limit=5

Параметр Описание

login ✔ Логин (на выбор: GET параметр или basic access authentication)

password ✔ Пароль (на выбор: GET параметр или basic access authentication)

Страница 2 MESSAGES REST V2

statusQueueName ✔ Название очереди статусов сообщений. Название очереди устанавливается при передаче

сообщения

limit Количество запрашиваемых статусов из очереди (по умолчанию 1, макс. 1000)

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

A132571BC;delivered A132571BD;smsc submit A132571BE;queued

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

Параметр/значение Описание

queue is empty Очередь пуста

absent status queue name Не указано название очереди статусов сообщений

invalid status queue name Неверно указано название очереди статусов сообщений

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

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

http://apisms.expecto.me/messages/v2/balance/

Параметр Описание

login ✔ Логин (на выбор: GET параметр или basic access authentication)

password ✔ Пароль (на выбор: GET параметр или basic access authentication)

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

RUB;540.15;0.0 SMS;589;100

где в каждой строке 1 значение – тип баланса, 2 значение – баланс, 3 значение – кредит (возможность использовать сервис при отрицательном балансе)

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

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

http://apisms.expecto.me/messages/v2/senders/

Параметр Описание

login ✔ Логин (на выбор: GET параметр или basic access authentication)

password ✔ Пароль (на выбор: GET параметр или basic access authentication)

Страница 3 MESSAGES REST V2

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

MyBrand;active; 3132018;pending; MegaFon;blocked;bad sender name TEST;default;

где в каждой строке 1 значение – имя подписи, 2 значение – статус, 3 значение – примечание

Параметр/значение Описание

active Подпись активирована и готова к использованию

new Новая подпись

pending Подпись в процессе активации

blocked Подпись заблокирована

default Подпись по умолчанию, готова к использованию

Проверка активной версии API

GET запрос

http://apisms.expecto.me/messages/v2/version/

Параметр Описание

login ✔ Логин (на выбор: GET параметр или basic access authentication)

password ✔ Пароль (на выбор: GET параметр или basic access authentication)

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

2

где выводится номер активной версии API

Страница 4 MESSAGES REST V2