SMSFeedback API
Стандартный API использует GET запрос для отправки сообщений и обычно используется для оптимизации бизнес-процессов компании (сообщения о статусе товара или услуги клиенту) или организации небольших смс рассылок по вашей базе данных.
Проверку статуса отправленных сообщений можно реализовать двумя способами:
- используя GET запрос на проверку состояния сообщения. Данный способ позволяет проверять статус 1 смс сообщения при помощи одного запроса.
- второй вариант - это проверка очереди отправленных сообщений (очередь назначается при отправке сообщений параметром statusQueueName). Данный способ позволят проверить одним запросом до 1000 статусов последних смс в данной очереди.
- Передача сообщения
- Проверка состояния сообщения
- Проверка очереди статусов сообщений
- Проверка состояния счета
- Список доступных подписей отправителя
Передача сообщения
GET запрос на сервер, вида:
| Параметр | Статус | Описание |
|---|---|---|
| api_login | Обязательно | |
| api_password | Обязательно | |
| phone | Обязательно | Номер телефона, в формате 71234567890 (функция проверки номера телефона на PHP) |
| text | Обязательно | Текст сообщения, в UTF-8 кодировке (функция смены кодировки с windows-1251 на 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). Для смены часового пояса необходимо изменять само время, "+00:00" - неизменно. | |
| statusQueueName | Название очереди статусов отправленных сообщений, в случае, если вы хотите использовать очередь статусов отправленных сообщений. От 3 до 16 символов, буквы и цифры (например, myQueue1) |
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
где до знака «=» сервис выдает идентификатор сообщения, а после знака «=» ответ сервиса о статусе сообщения:
| Параметр | Описание |
|---|---|
| accepted | Сообщение принято сервисом |
| invalid mobile phone | Неверно задан номер тефона (формат 71234567890) |
| text is empty | Отсутствует текст |
| text must be string | Текст не на латинице или не в utf-8 (функция смены кодировки с windows-1251 на UTF-8) |
| sender address invalid | Неверная (незарегистрированная) подпись отправителя |
| wapurl invalid | Неправильный формат wap-push ссылки |
| invalid schedule time format | Неверный формат даты отложенной отправки сообщения |
| invalid status queue name | Неверное название очереди статусов сообщений |
| not enough credits | Баланс пуст (проверьте баланс) |
Проверка состояния отправленного сообщения
GET запрос на сервер, вида:
| Параметр | Статус | Описание |
|---|---|---|
| api_login | Обязательно | |
| api_password | Обязательно | |
| id | Обязательно | Идентификатор сообщения, который вернул сервис при отправке сообщения |
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
где до знака «=» сервис выдает идентификатор сообщения, а после знака «=» ответ сервиса о статусе сообщения:
| Параметр | Описание |
|---|---|
| queued | Сообщение находится в очереди |
| delivered | Сообщение доставлено |
| delivery error | Ошибка доставки SMS (абонент в течение времени доставки находился вне зоны действия сети или номер абонента заблокирован) |
| smsc submit | Сообщение доставлено в SMSC |
| smsc reject | Сообщение отвергнуто SMSC (номер заблокирован или не существует) |
| incorrect id | Неверный идентификатор сообщения |
Проверка очереди статусов отправленных сообщений
GET запрос на сервер, вида:
| Параметр | Статус | Описание |
|---|---|---|
| api_login | Обязательно | |
| api_password | Обязательно | |
| statusQueueName | Обязательно | Название очереди статусов сообщений. Название очереди устанавливается при передаче сообщения |
| limit | Количество запрашиваемых статусов из очереди (по умолчанию 1, макс. 1000) |
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
A132571BC=delivered
A13257316=smsc submit
A1325753A=delivery error
A13257316=delivered
где сервис возвращает по одному статусу в каждой строке (подробнее о статусах)
| Параметр | Описание |
|---|---|
| queue is empty | Очередь пуста |
| absent status queue name | Не указано название очереди статусов сообщений |
| invalid status queue name | Неверно указано название очереди статусов сообщений |
Проверка состояния счета
GET запрос на сервер, вида:
| Параметр | Статус | Описание |
|---|---|---|
| api_login | Обязательно | |
| api_password | Обязательно |
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
где цифра, это количество доступных SMS на балансе (без учета возможного кредита).
Список доступных подписей отправителя
GET запрос на сервер, вида:
| Параметр | Статус | Описание |
|---|---|---|
| api_login | Обязательно | |
| api_password | Обязательно |
При успешной авторизации, в ответ сервис должен вернуть plain/text ответ вида:
Sender_two
Sender_three
где выводится список доступных подписей по одной в каждой строке.