SMSPORTAL.PRO - API

Версия 1.1

1. Обзор

SMS API представляет собой способ передачи SMS-сообщений, предназначенных к отправке, на сервер http://smsportal.pro, а также способ запросов статуса SMS-сообщений, поставленных в очередь на отправку..

2. Отправка СМС

Адрес приложения:

http://smsportal.pro/index.php?r=site/ApiSendSms

Метод: GET

user=(имя пользователя)
data=(пароль, для тестирования)
pwd=(MD5 от пароля, в рабочем режиме)
from=(адрес отправителя)
to=(адрес получателя)
msg=(сообщение в UTF-8)

Ответ при ошибке:

<data> <responce>ERROR</responce> <textError>{Текст ошибки}</textError> </data>

Например:

http://smsportal.pro/index.php?r=site/ApiSendSms&user=demo&data=demo&from=systemTest&to=79010000000&msg=test

В запросе должен быть один из параметров data или pwd. Параметр from - не обязателен (по умолчанию используется присвоенный пользователю Sender ID). Все остальные параметры - обязательные.

3. Запрос статуса сообщения

http://smsportal.pro/index.php?r=site/ApiSendSms

Метод: GET

user=(имя пользователя)
data=(пароль, для тестирования)
pwd=(MD5 от пароля, в рабочем режиме)
id=(идентификатор)

Ответ при успехе:

<data> <responce>OK</responce> <id>{ID сообщения}</id> <status>{статус}</status> </data>

Статусы:

Сообщение не найдено в базе - пустой
Ожидает отправки                        - 1
Отправлено                                    - 2
Ошибка отправки                          - 3
Доставлено                                     - 4
Не доставлено                               - 5
Получатель в чёрном списке      - 6

Ответ при ошибке: см. п. 2

Пример:

http://smsportal.pro/index.php?r=site/ApiSendSms&user=demo&data=demo&id=53

4. Запрос баланса

Адрес приложения:

http://smsportal.pro/index.php?r=site/ApiSendSms

Метод: GET

user=(имя пользователя)
data=(пароль, для тестирования)
pwd=(MD5 от пароля, в рабочем режиме)
balance=1

Ответ при успехе:

<data> <responce>OK</responce> <active>{Активен ли пользователь}</active> <balance>{Баланс в рублях}</balance> <count_free_sms>{Число бонусных SMS}</count_free_sms> <tariff>{Цена SMS в рублях}</tariff> <from>{Адрес отправителя}</from> </data>

Ответ при ошибке: см. п. 2

В запросе должен быть один из параметров data или pwd. Все остальные параметры - обязательные.

Пример ответа:

<data> <responce>OK</responce> <active>1</active> <balance>103</balance> <count_free_sms>0</count_free_sms> <tariff>0.6</tariff> <from>SMS Office</from> </data>

Пример:

http://smsportal.pro/index.php?r=site/ApiSendSms&user=demo&data=demo&balance=1