# Отправка SMS, Viber, Flash SMS, WAP-Push

## Отправка SMS, Viber, Flash SMS, WAP-Push

<mark style="color:green;">`POST`</mark> `http://lk.mysmpp.ru/xml`

#### Headers

| Name                                           | Type   | Description                    |
| ---------------------------------------------- | ------ | ------------------------------ |
| Content-type<mark style="color:red;">\*</mark> | String | **`text/xml; charset=utf-8;`** |

#### Request Body

| Name                                                    | Type   | Description                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| login.value<mark style="color:red;">\*</mark>           | String | Ваш логин в системе                                                                                                                                                                                                                                                                                       |
| message.address.region                                  | String | Область для vCard                                                                                                                                                                                                                                                                                         |
| message.address.city                                    | String | Город для vCard                                                                                                                                                                                                                                                                                           |
| message.address.street                                  | String | Улица для vCard                                                                                                                                                                                                                                                                                           |
| message.address.post\_office\_box                       | Int    | Абонентский ящик для vCard                                                                                                                                                                                                                                                                                |
| message.organization                                    | String | Организация для vCard                                                                                                                                                                                                                                                                                     |
| message.position                                        | String | Должность контакта для vCard                                                                                                                                                                                                                                                                              |
| message.email                                           | String | E-mail для vCard                                                                                                                                                                                                                                                                                          |
| message.phone.fax                                       | Int    | Номер факса для vCard                                                                                                                                                                                                                                                                                     |
| message.phone.work                                      | Int    | Номер рабочего телефона для vCard                                                                                                                                                                                                                                                                         |
| message.phone.cell                                      | Int    | Номер телефона для vCard                                                                                                                                                                                                                                                                                  |
| message.name                                            | String | Имя для vCard                                                                                                                                                                                                                                                                                             |
| message.url                                             | String | Ссылка для WAP Push или vCard                                                                                                                                                                                                                                                                             |
| message.abonent.time\_send                              | date   | <p>Дата и время отправки в формате:</p><p>YYYY-MM-DD HH:MM</p><p>где,<br>   YYYY-год,<br>   MM-месяц,<br>   DD-день,<br>   HH-часы, </p><p>   MM-минуты</p><p><mark style="color:orange;">! Если не задано, то Viber сообщение имеет максимальный срок жизни (один день)</mark></p>                       |
| message.abonent.client\_id\_sms                         | String | <p>Число присваиваемое клиентом </p><p><mark style="color:orange;">! Необязательный параметр, позволяет избежать повторной отправки. Если раннее с этого аккаунта уже было отправлено SMS с таким номером, то повторная отправка не производится, а возвращается номер ранее отправленного SMS</mark></p> |
| message.abonent.number\_sms                             | Int    | Номер сообщения в пределах отправляемого XML документа                                                                                                                                                                                                                                                    |
| message.image\_viber                                    | String | Адрес картинки для Viber сообщения                                                                                                                                                                                                                                                                        |
| message.action\_viber                                   | String | Ссылка для кнопки Viber сообщения                                                                                                                                                                                                                                                                         |
| message.button\_viber                                   | String | Текст кнопки Viber сообщения                                                                                                                                                                                                                                                                              |
| message.text\_viber<mark style="color:red;">\*</mark>   | String | Текст Viber сообщения                                                                                                                                                                                                                                                                                     |
| message.sender\_viber<mark style="color:red;">\*</mark> | String | Отправитель Viber сообщения                                                                                                                                                                                                                                                                               |
| message.type                                            | String | <p>Тип SMS сообщения:<br>  - flashsms – Flash SMS</p><p>  - silence – невидимые SMS (для проверки статуса абонента)</p><p>  - sms – обычная SMS</p><p>  - wappush – WAP-Push</p><p>  - vcard – визитная карточка (vCard)</p>                                                                              |
| message.type\_send\_2                                   | String | Тип досылаемого сообщения, в случае если отправляемое сообщение не будет доставлено (**`viber`** или **`sms`**)                                                                                                                                                                                           |
| message.type\_send\_1<mark style="color:red;">\*</mark> | String | Тип отправляемого сообщения (**`viber`** или **`sms`**)                                                                                                                                                                                                                                                   |
| token.value<mark style="color:red;">\*</mark>           | String | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру.                                                                                                                                                                                                       |
| password.value<mark style="color:red;">\*</mark>        | String | Ваш пароль в системе                                                                                                                                                                                                                                                                                      |
| message.sender<mark style="color:red;">\*</mark>        | String | <p>Отправитель SMS сообщения</p><p><mark style="color:red;">! Именно это значение будет выводиться на телефоне абонента в поле от кого SMS</mark></p>                                                                                                                                                     |
| message.text<mark style="color:red;">\*</mark>          | String | Текст SMS сообщения                                                                                                                                                                                                                                                                                       |
| abonent.phone<mark style="color:red;">\*</mark>         | Int    | Номер абонента, которому адресована SMS                                                                                                                                                                                                                                                                   |
| message.additional                                      | String | Дополнительная информация для vCard                                                                                                                                                                                                                                                                       |
| message.address.country                                 | String | Страна для vCard                                                                                                                                                                                                                                                                                          |
| message.address.postal\_code                            | Int    | Индекс для vCard                                                                                                                                                                                                                                                                                          |

{% tabs %}
{% tab title="200: OK В случае получения правильного XML-документа" %}

```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>
```

{% endtab %}

{% tab title="400: Bad Request В случае возникновения ошибки в отправленном XML-документе" %}

```xml
<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>текст ошибки</error>
</response>
```

{% endtab %}
{% endtabs %}

### Расшифровка параметров в ответах на запрос

<table><thead><tr><th width="174.33333333333331">Параметр</th><th width="149">Тип данных</th><th>Описание</th></tr></thead><tbody><tr><td>information.number_sms</td><td>Int</td><td>Номер сообщения, указанный при отправке XML документа</td></tr><tr><td>information.id_sms</td><td>Int</td><td><p>Номер SMS сообщения. Используется для проверки статуса SMS.</p><p><mark style="color:orange;">Если в процессе отправки SMS произошла ошибка, то id_sms не передается</mark></p></td></tr><tr><td>information.parts</td><td>Int</td><td>Количество частей SMS</td></tr><tr><td>information</td><td>String</td><td><p>Статус сообщения («send»), если SMSбыла отправлена, или сообщение об ошибке, если в процессе отправки SMS произошла ошибка:</p><ul><li>У нас закончились SMS. Для разрешения проблемы свяжитесь с менеджером</li><li>Закончились SMS</li><li>Аккаунт заблокирован</li><li>Укажите номер телефона</li><li>Номер телефона присутствует в стоп-листе</li><li>Данное направление закрыто для вас</li><li>Данное направление закрыто</li><li>Текст SMS отклонен модератором</li><li>Нет отправителя</li><li>Отправитель не должен превышать 15 символов для цифровых номеров и 11 символов для буквенно-числовых</li><li>Номер телефона должен быть меньше 15 символов</li><li>Нет текста сообщения</li><li>Нет ссылки</li><li>Укажите название контакта и хотя бы один параметр для визитной карточки</li><li>Такого отправителя нет</li><li>Отправитель не прошел модерацию</li></ul></td></tr><tr><td>error</td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

### Пример XML запроса

```xml
<?xml version="1.0" encoding="utf-8" ?>
<request>
  <message type_send_1="viber или sms" type_send_2="viber или sms" type="flashsms или silence или sms или wappush или vcard">
   <sender_viber>Отправитель Viber сообщения</sender_viber>
   <text_viber>Текст сообщения</text_viber>
   <button_viber>Текст кнопки</button_viber>
   <action_viber>Ссылка для кнопки</action_viber>
   <image_viber>Адрес картинки</image_viber>
   <sender>Отправитель 1</sender>
   <text>Текст сообщения 1</text>
   <url>Адрес для WAP Push или vCard</url>
   <name>Имя для vCard</name>
   <phone cell="79033256699" work="79033256699" fax="79033256699"/>
   <email>E-mail vCard</email>
   <position>Должность vCard</position>
   <organization>Организация vCard</organization>
   <address post_office_box="абонентскийящик" street="Улица" city="город" region="Область" postal_code="Индекс" country="Страна" />
   <additional>Дополнительная информация vCard</additional>
   <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>
 <message>
   <sender>Отправитель 2</sender>
   <text>Текстсообщения 2</text>
   <abonent phone="79033256699" number_sms="11" client_id_sms="111" />
   <abonent phone="79033256699" number_sms="12" client_id_sms="112" />
   ...
   <abonent phone="79033256699" number_sms="20" client_id_sms="120" />
</message>
 ...
<security>
   <login value="логин" />
   <password value="пароль" />
</security>
</request>
```