API / HTTP/HTTPS протокол / Управление шаблонами сообщений

API позволяет рассылать сообщения через ваши проекты и сервисы по протоколам HTTP/HTTPS, SMTP и SMPP. Готовые библиотеки на разных языках программирования подключаются к вашему проекту и помогают отправлять сообщения из любого места с помощью одной команды.



ОТПРАВКА СООБЩЕНИЙ

Отправка SMS-сообщения

Комментарии в SMS-сообщениях

Отправка на группу номеров

Отправка HLR-запроса

Отправка MMS-сообщения

Отправка e-mail сообщения

Отправка голосового сообщения (звонок)

Отправка viber-сообщения

Использование префиксов при отправке сообщений

Управление шаблонами сообщений

Виртуальная отправка (режим тестирования)

УПРАВЛЕНИЕ РАССЫЛКАМИ

СТАТУСЫ СООБЩЕНИЙ

ПРОВЕРКА СОСТОЯНИЯ БАЛАНСА

УПРАВЛЕНИЕ КОНТАКТАМИ

УПРАВЛЕНИЕ ИМЕНАМИ ОТПРАВИТЕЛЕЙ (SENDER ID)

ПОЛУЧЕНИЕ ДАННЫХ

РАЗНОЕ

Управление шаблонами сообщений

Для управления шаблонами сообщений необходимо вызвать методом GET или POST соответствующий адрес с указанием требуемой команды и параметров.

Для создания шаблона: http://my.smscab.ru/sys/templates.php?add=1&login=<login>&psw=<password>&name=<name>&msg=<msg>
Для изменения шаблона: http://my.smscab.ru/sys/templates.php?chg=1&login=<login>&psw=<password>&id=<id>
Для удаления шаблона: http://my.smscab.ru/sys/templates.php?del=1&login=<login>&psw=<password>&id=<id>
Для получения списка шаблонов: http://my.smscab.ru/sys/templates.php?get=1&login=<login>&psw=<password>
Серверу передаются следующие параметры:

ПараметрЗначение
loginЛогин Клиента.
pswПароль Клиента или MD5-хеш пароля в нижнем регистре.
nameНазвание шаблона.
msgТекст сообщения.
formatФормат сообщения:
пустая строка – не задан.
sms – SMS-сообщение.
flash – Flash-SMS.
bin – Бинарное SMS.
push – Wap-push.
mms – MMS.
call – Звонок.
mail – E-mail.
whatsapp – WhatsApp.
viber – Viber.
senderИмя отправителя.
fl[1]Использовать для автоподписи.

В случае ошибки Сервер возвращает следующую строку:
  • При fmt = 0:
    ERROR = N (описание)

  • При fmt = 1:
    0,-N

  • При fmt = 2:
    <result>
    <error>описание</error>
    <error_code>N</error_code>
    </result>

  • При fmt = 3:
    {
    "error": "описание",
    "error_code": N
    }
N – номер ошибки, может принимать следующие значения:

ЗначениеОписание
1Ошибка в параметрах.
2Неверный логин или пароль.
3Запись не найдена.
4IP-адрес временно заблокирован.
5Ошибка сохранения или удаления.
9Попытка отправки более трех одинаковых запросов на действия с шаблонами.

В случае успешного запроса Сервер возвращает ответ в виде строки:

При создании шаблона:
  • при fmt = 0: ID - <id>

  • при fmt = 1: <id>

  • при fmt = 2:
    <template>
    <id>id</id>
    <template>

  • при fmt = 3:
    {
    "id": <id>
    }

При изменении или удалении шаблона:
  • при fmt = 0, 1: OK

  • при fmt = 2:
    <result>OK</result>

  • при fmt = 3:
    {
    "result": "OK"
    }


При запросе списка шаблонов сообщений:
  • при fmt = 0:
    id = <id>, name = <name>, format = <format>, sender = <sender>, flag = <flag>, message = <message>
    ...

  • при fmt = 1:
    <id>,<name>,<format>,<sender>,<flag>,<message>
    ...

  • при fmt = 2:
    <list>
    <template>
    <id>id</id>
    <name>name</name>
    <format>format</format>
    <sender>sender</sender>
    <flag>flag</flag>
    <message>message</message>
    </template>
    ...
    </list>

  • при fmt = 3:
    [{
    "id": <id>,
    "name": "<name>",
    "format": "<format>",
    "sender": "<sender>",
    "flag": <flag>,
    "message": "<message>"
    },
    ...]

Где:
<id> – идентификатор шаблона, назначенный системой автоматически.
<name> – название шаблона.
<format> – формат сообщения.
<sender> – имя отправителя.
<flag> – флаг для шаблона. Установка первого бита флага (fl[1]=1) назначает использование шаблона для автоподписи.
<message> – текст сообщения.

Сервер не принимает более трех одинаковых запросов на действия с шаблонами в течение минуты для снижения нагрузки и защиты от ошибок и зацикливаний в программе на стороне Клиента.