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

Спецификации для отправки сообщения: JSON, XML, HTTP GET

Метод отправки POST

Кодировка XML-документов: UTF-8

Обязательный заголовок: Content-type: text/xml; charset=utf-8;

Адрес для запроса: https://my3.webcom.mobi/xml

Примеры

Пример отправки SMS сообщения Пример отправки Viber сообщения Пример отправки Каскадного сообщения

Параметры запроса на отправку сообщения

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

request

.security

.login

[value]*

String

Ваш логин в системе

request

.security

.password

[value]*

String

Ваш пароль в системе

request

.security

.token

[value]*

String

Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру

request

.message

[type_send_1]*

String

Тип отправляемого сообщения

  • viber

  • sms

  • flashcall

  • hlr

request

.message

[type_send_2]

String

Тип досылаемого сообщения, в случае если отправляемое сообщение не будет доставлено по первому типу направления request.message[type_send_1], применяется для каскадной отправки

  • viber

  • sms

request

.message

[type]

String

Тип сообщения:

  • silence – невидимые SMS (для проверки статуса абонента)

  • sms – обычная SMS

  • flashcall

  • hlr

request

.message

.sender*

String

Отправитель SMS, HLR, FlashCall сообщения

!Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение

request

.message

.text*

String

Текст SMS, HLR, FlashCall сообщения

request

.message

.abonent

[phone]*

Int

Номер абонента, которому адресовано сообщение

request

.message

.abonent

[number_sms]

Int

Номер сообщения в пределах отправляемого XML документа

request

.message

.abonent

[client_id_sms]

Int

Число присваиваемое клиентом

!Необязательный параметр, позволяет избежать повторной отправки. Если раннее с этого аккаунта уже было отправлено SMS с таким номером, то повторная отправка не производится, а возвращается номер ранее отправленного SMS

request

.message

.abonent

[time_send]

date

Дата и время отправки в формате:

YYYY-MM-DD HH:MM

где, YYYY-год, MM-месяц, DD-день, HH-часы,

MM-минуты

!Если не задано, то сообщение имеет максимальный срок жизни (один день)

request

.message

.abonent

[validity_period]

date

Дата и время, после которых не будут делаться попытки доставить SMS в формате:

YYYY-MM-DD HH:MM:SS

где, YYYY - год, MM - месяц, DD - день, HH - часы,

MM - минуты

SS - секунды

!Если не задано, то SMS имеет максимальный срок жизни (один день)

request

.message

.abonent

[validity_period_viber]

date

Дата и время, после которых не будут делаться попытки доставить Viber в формате:

YYYY-MM-DD HH:MM:SS

где, YYYY - год, MM - месяц, DD - день, HH - часы,

MM - минуты

SS - секунды

!Если не задано, то Viber имеет максимальный срок жизни (один день)

request

.message

.sender_viber

String

Отправитель Viber сообщения

request

.message

.text_viber

String

Текст Viber сообщения

request

.message

.button_viber

String

Текст кнопки Viber сообщения

request

.message

.action_viber

String

Ссылка для кнопки Viber сообщения

request

.message

.image_viber

String

Адрес картинки для Viber сообщения

*- обязательный параметр

В случае получения правильного XML-документа

<?xml  version="1.0" encoding="utf-8" ?>
<response>
     <information number_sms="1" id_sms="ID SMS в системе для проверки статуса" parts="2">Статус/сообщение об ошибке</information>
     <information number_sms="2" id_sms="ID SMS в системе для проверки статуса" parts="2">Статус/сообщение об ошибке</information>
     <information number_sms="3" id_sms="ID SMS в системе для проверки статуса" parts="2">Статус/сообщение об ошибке</information>
…
</response>
Параметр
Тип
Описание

response

.information

[number_sms]

Int

Номер сообщения, указанный при отправке XML документа

response

.information

[id_sms]

String

Номер SMS сообщения. Используется для проверки статуса SMS.

!Если в процессе отправки SMS произошла ошибка, то id_sms не передается

response

.information

[parts]

Int

Количество частей SMS

response

.information

String

Статус сообщения («send»), если была отправлена, или сообщение об ошибке, если в процессе отправки произошла ошибка:

  • У нас закончились SMS. Для разрешения проблемы свяжитесь с менеджером

  • Закончились SMS

  • Аккаунт заблокирован

  • Укажите номер телефона

  • Номер телефона присутствует в стоп-листе

  • Данное направление закрыто для вас

  • Данное направление закрыто

  • Текст SMS отклонен модератором

  • Нет отправителя

  • Отправитель не должен превышать 15 символов для цифровых номеров и 11 символов для буквенно-числовых

  • Номер телефона должен быть меньше 15 символов

  • Нет текста сообщения

  • Нет ссылки

  • Укажите название контакта и хотя бы один параметр для визитной карточки

  • Такого отправителя нет

  • Отправитель не прошел модерацию

В случае возникновения ошибки в отправленном XML-документе

<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>Текст ошибки</error>
</response>
Параметр
Тип
Описание

response

.error

String

Текст ошибки может принимать следующие значения:

  • Неправильный формат XML документа

  • Ваш аккаунт заблокирован

  • Неправильный логин или пароль

  • POST данные отсутствуют

Пример XML-документа для отправки SMS сообщения

<?xml version="1.0" encoding="utf-8" ?>
<request>
     <message type_send_1="sms" type="sms">
          <sender>Отправитель</sender>
          <text>Текст сообщения</text>
          <abonent phone="79033256699" number_sms="1" client_id_sms="101" time_send="2001-12-31 12:34:54" validity_period="2001-12-31 15:34:54" />
          <abonent phone="79033256699" number_sms="2" client_id_sms="102" time_send="2001-12-31 12:35:54" />
          ...
          <abonent phone="79033256699" number_sms="10" client_id_sms="110" time_send="" />
     </message>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
</request>

Пример XML-документа для отправки Viber сообщения

<?xml version="1.0" encoding="utf-8" ?>
<request>
    <message type_send_1="viber" type="sms">
        <sender_viber>Отправитель Viber сообщения</sender_viber>
        <text_viber>Текст сообщения</text_viber>
        <button_viber>Текст кнопки</button_viber>
        <action_viber>Ссылка для кнопки</action_viber>
        <image_viber>Адрес картинки</image_viber>
        <abonent phone="79033256699" number_sms="1" client_id_sms="101" time_send="2001-12-31 12:34:54" validity_period_viber="2001-12-31 15:34:54" />
        <abonent phone="79033256699" number_sms="2" client_id_sms="102" time_send="2001-12-31 12:35:54" />
        ...
        <abonent phone="79033256699" number_sms="10" client_id_sms="110" time_send="" />
    </message>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
</request>

Пример XML-документа для отправки Каскадного сообщения

<?xml version="1.0" encoding="utf-8" ?>
<request>
    <message type_send_1="viber" type_send_2="sms" type="sms">
        <sender_viber>Отправитель Viber сообщения</sender_viber>
        <text_viber>Текст сообщения Viber</text_viber>
        <button_viber>Текст кнопки Viber</button_viber>
        <action_viber>Ссылка для кнопки Viber</action_viber>
        <image_viber>Адрес картинки Viber</image_viber>
        <sender>Отправитель SMS сообщения</sender>
        <text>Текст сообщения SMS</text>
        <abonent phone="79033256699" number_sms="1" client_id_sms="101" time_send="2001-12-31 12:34:54" validity_period="2001-12-31 15:34:54" validity_period_viber="2001-12-31 15:34:54" />
        <abonent phone="79033256699" number_sms="2" client_id_sms="102" time_send="2001-12-31 12:35:54" />
        ...
        <abonent phone="79033256699" number_sms="10" client_id_sms="110" time_send="" />
    </message>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
</request>

Last updated