api.sms Отправка SMS

Для работы с методом api.sms необходимо подключение к SMS-центру, параметры подключения указываются в конфигурационном файле dbaccess.properties (SMS).

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

Методы api.sms выполняют валидацию аргументов from и text.

Также данная группа методов выполняет исправление аргумент phone. Если номер телефона начинается не с "+7" или "8", то в начало номера будет добавлен код страны "+7".

  • api.sms.sendSms(from, phone, text)

    Отправка SMS-сообщения до 127 символов, см. Оповещение по SMS.

    Параметры метода:

    • from — автор сообщения, не более 20 байтов. String
    • phone — номер телефона, на который будет отправлено сообщение. String
    • text — текст сообщения, не более 127 символов. String

    В случае, если from или text превышают ограничения или произошла ошибка при отправке сообщения, обрабатывается исключение.

  • api.sms.sendLargeSms(from, phone, text)

    Отправка длинного SMS-сообщения до 400 символов.

    Параметры метода:

    • from — автор сообщения, не более 20 байтов. String
    • phone — номер телефона, на который будет отправлено сообщение. String
    • text — текст сообщения, не более 400 символов. String

    В случае, если from или text превышают ограничения или произошла ошибка при отправке сообщения, обрабатывается исключение.

Отправка SMS-сообщений без валидации

  • api.sms.createSmsMessage(phone, text)

    Создание и отправка SMS-сообщения.

    Параметры метода:

    • phone — номер телефона, на который будет отправлено сообщение. String
    • text — текст сообщения. String

    Пример:

    def message = api.sms.createSmsMessage('71234567890', 'Text')
message.setFrom('Author')
api.sms.sendSms(message)

  • api.sms.createSmsMessage(smsMessage)

    Создание и отправка SMS-сообщения.

    Интерфейс ISmsMessage позволяет задавать следующие параметры через следующие методы:

    • setTo(to) — номер телефона, на который будет отправлено сообщение. String;
    • setFrom(from) — отправитель сообщения. String;
    • setText(text) — текст сообщения. String;
    • setCompressed(isCompressed)) — сжатие сообщения, Boolean, если true (по умолчанию) — сжатое сообщение.

Дополнительные параметры отправки SMS-сообщений

  • api.sms.setSourceAddrNpi(sourceAddrNpi)

    Установка значения параметра "Идентификатор плана нумерации отправителя" — source_addr_npi (NumberingPlanIndicator).

    Параметр метода:

    • sourceAddrNpi — устанавливаемое значение параметра. int

      Возможные значения:

      • 0 — Unknown
      • 1 — ISDN (E163/E164)
      • 2 — Data (X.121)
      • 3 — Telex (F.69)
      • 4 — Land Mobile (E.212)
      • 5 — National
      • 6 — Private
      • 7 — ERMES
      • 8 — Internet (IP)
      • 9 — WAP Client Id (его должен определять WAP Forum)

  • api.sms.setSourceAddrTon(sourceAddrTon)

    Установка значения параметра "Тип номера отправителя" — source_addr_ton (TypeOfNumber).

    Параметр метода:

    • sourceAddrTon — устанавливаемое значение параметра. int

      Возможные значения:

      • 0 — Неизвестный (Unknown)
      • 1 — Международный (International)
      • 2 — Государственный (National)
      • 3 — Сетевой Специальный (Network Specific)
      • 4 — Номер Абонента (Subscriber Number)
      • 5 — Алфавитно-цифровой (Alphanumeric)
      • 6 — Сокращенный (Abbreviated)