# Общая информация

Спасибо за выбор Webcom Mobi API. Данный API позволяет работать со всеми основными возможностями Webcom Mobi, благодаря чему вы можете быстро наладить взаимодействие с нашим сервисом.

### Авторизация

Для корректной работы всех последующих примеров вам потребуется логин и пароль или ключ для доступа к Webcom Mobi API. Чтобы получить токен для авторизации, свяжитесь с закрепленным за вашей учетной записью менеджером.

### Поддерживаемые типы отправки:

* SMS сообщение
* Viber сообщение
* Голосовое сообщение
* Отправка кодов голосом(VoiceCode)
* FlashСall
* HLR
* Каскадная отправка Viber + SMS
* Каскадная отправка FlashCall + SMS

**Запросы необходимо отправлять в UTF-8 кодировке.**\
\
Не стоит использовать URL длиной более 2,000 символов. Но этот параметр зависит от многих факторов и [может различаться в большую или меньшую сторону](https://github.com/dreikanter/paradigm.ru/blob/master/posts/2007-12-19_url-max-length.md). Одинаковые запросы можно отправлять не чаще 1 раза в 1 минуту. В случае ошибки вернется:

```
error: Попытка отправки более одного одинакового запроса в течение минуты
```

### Варианты взаимодействия с API

С нашим API можно работать в формате JSON, XML и HTTP GET.


# История изменений

## 2023-08-10, v05

* JSON. Расширен вывод данных при запросе статуса сообщения. Если указывается параметр detail=1, то дополнительно выводится MCC, MNC по отправленому номеру телефона.
* XML. Добавлена возможность авторизироваться через token.

## 2023-07-15, v04

* XML. В запросе проверки баланса теперь возвращается количество сообщений других типов (Viber, VK, OK и тд.).
* XML. Появилась возможность добавлять шаблоны сервисных сообщений, указывая следующие данные: ИНН, КПП, ОГРН, название организации или ИП, имя отправителя, оператор, тариф оператора, список документов в доступных форматах.

## 2023-06-22, v03

* XML. Добавлена возможность добавлять имена отправителей.
* GET. Изменен вид ответа на json.

## 2023-05-07, v02

* GET. Добавленна возможность регистрации клиентов.
* JSON. Добавлена возможность авторизации через token.
* JSON. Добавлена возможность запрашивать статус сообщения по id.

## 2023-04-12, v01

* GET. Добавлена возможность отправлять Viber сообщения.


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

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

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### **Примеры**

[Пример отправки SMS сообщения<br>](#primer-xml-dokumenta-dlya-otpravki-sms-soobsheniya)[Пример отправки Viber сообщения<br>](#primer-xml-dokumenta-dlya-otpravki-viber-soobsheniya)[Пример отправки Каскадного сообщения](#primer-xml-dokumenta-dlya-otpravki-kaskadnogo-soobsheniya)

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

<table><thead><tr><th width="207.66666666666666">Параметр</th><th width="87">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p><mark style="color:green;">[type_send_1]</mark>*</p></td><td>String</td><td><p>Тип отправляемого сообщения </p><ul><li>viber </li><li>sms</li><li>flashcall</li><li>hlr</li></ul></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p><mark style="color:green;">[type_send_2]</mark></p></td><td>String</td><td><p>Тип досылаемого сообщения, в случае если отправляемое сообщение не будет доставлено по первому типу направления <em>request<mark style="color:blue;">.message[type_send_1]</mark></em>, применяется для каскадной отправки</p><ul><li>viber </li><li>sms</li></ul></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p><mark style="color:green;">[type]</mark></p></td><td>String</td><td><p>Тип сообщения:</p><ul><li>silence – невидимые SMS (для проверки статуса абонента)</li><li>sms – обычная SMS</li><li>flashcall </li><li>hlr</li></ul></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">sender</mark>*</p></td><td>String</td><td><p>Отправитель SMS, HLR, FlashCall сообщения</p><p><em>!Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение</em></p></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">text</mark>*</p></td><td>String</td><td>Текст SMS, HLR, FlashCall сообщения</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">abonent</mark></p><p><mark style="color:orange;">[phone]</mark>*</p></td><td>Int</td><td>Номер абонента, которому адресовано сообщение</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">abonent</mark></p><p><mark style="color:orange;">[number_sms]</mark></p></td><td>Int</td><td>Номер сообщения в пределах отправляемого XML документа</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">abonent</mark></p><p><mark style="color:orange;">[client_id_sms]</mark></p></td><td>Int</td><td><p>Число присваиваемое клиентом </p><p><em>!Необязательный параметр, позволяет избежать повторной отправки. Если раннее с этого аккаунта уже было отправлено SMS с таким номером, то повторная отправка не производится, а возвращается номер ранее отправленного SMS</em></p></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">abonent</mark></p><p><mark style="color:orange;">[time_send]</mark></p></td><td>date</td><td><p>Дата и время отправки в формате:</p><p>YYYY-MM-DD HH:MM</p><p>где,<br>   YYYY-год,<br>   MM-месяц,<br>   DD-день,<br>   HH-часы, </p><p>   MM-минуты</p><p><em>!Если не задано, то сообщение имеет максимальный срок жизни (один день)</em></p></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">abonent</mark></p><p><mark style="color:orange;">[validity_period]</mark></p></td><td>date</td><td><p>Дата и время, после которых не будут делаться попытки доставить SMS в формате:</p><p><em>YYYY-MM-DD HH:MM:SS</em></p><p>где,<br>    YYYY - год,<br>    MM - месяц,<br>    DD - день,<br>    HH - часы, </p><p>    MM - минуты</p><p>    SS - секунды</p><p><em>!Если не задано, то SMS имеет максимальный срок жизни  (один день)</em></p></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">abonent</mark></p><p><mark style="color:orange;">[validity_period_viber]</mark></p></td><td>date</td><td><p>Дата и время, после которых не будут делаться попытки доставить Viber в формате:</p><p><em>YYYY-MM-DD HH:MM:SS</em></p><p>где,<br>    YYYY - год,<br>    MM - месяц,<br>    DD - день,<br>    HH - часы, </p><p>    MM - минуты</p><p>    SS - секунды</p><p><em>!Если не задано, то Viber имеет максимальный срок жизни  (один день)</em></p></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">sender_viber</mark></p></td><td>String</td><td>Отправитель Viber сообщения</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">text_viber</mark></p></td><td>String</td><td>Текст Viber сообщения</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">button_viber</mark></p></td><td>String</td><td>Текст кнопки Viber сообщения</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">action_viber</mark></p></td><td>String</td><td>Ссылка для кнопки Viber сообщения</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.message</mark></p><p>.<mark style="color:green;">image_viber</mark></p></td><td>String</td><td>Адрес картинки для Viber сообщения</td></tr></tbody></table>

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

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

{% code fullWidth="false" %}

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

{% endcode %}

<table><thead><tr><th width="189.66666666666666">Параметр</th><th width="107">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.information</mark></p><p><mark style="color:green;">[number_sms]</mark></p></td><td>Int</td><td>Номер сообщения, указанный при отправке XML документа</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.information</mark></p><p><mark style="color:green;">[id_sms]</mark></p></td><td>String</td><td><p>Номер SMS сообщения. Используется для проверки статуса SMS.</p><p><em>!Если в процессе отправки SMS произошла ошибка, то id_sms не передается</em></p></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.information</mark></p><p><mark style="color:green;">[parts]</mark></p></td><td>Int</td><td>Количество частей SMS</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.information</mark></p></td><td>String</td><td><p>Статус сообщения («send»), если была отправлена, или сообщение об ошибке, если в процессе отправки произошла ошибка:</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></tbody></table>

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

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

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="115">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

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

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

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

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

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

{% endtab %}

{% tab title="JSON" %}
Метод отправки **`POST`**

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

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

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

### Примеры

[Пример отправки SMS сообщения<br>](#primer-json-dokumenta-dlya-otpravki-sms-soobsheniya)[Пример отправки Viber сообщения<br>](#primer-json-dokumenta-dlya-otpravki-viber-soobsheniya)[Пример отправки Каскадного сообщения](#primer-json-dokumenta-dlya-otpravki-kaskadnogo-soobsheniya)

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

<table><thead><tr><th width="207.66666666666666">Параметр</th><th width="87">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>login*</td><td>String</td><td>Ваш логин в системе</td></tr><tr><td>password<mark style="color:green;">*</mark></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td>token*</td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>message</p><p><mark style="color:green;">.type_send_1</mark>*</p></td><td>String</td><td><p>Тип отправляемого сообщения </p><ul><li>viber </li><li>sms</li><li>flashcall</li><li>hlr</li></ul></td></tr><tr><td><p>message</p><p><mark style="color:blue;">.type_send_2</mark></p></td><td>String</td><td><p>Тип досылаемого сообщения, в случае если отправляемое сообщение не будет доставлено по первому типу направления <em>message.<mark style="color:blue;">type_send_1</mark></em>, применяется для каскадной отправки</p><ul><li>viber </li><li>sms</li></ul></td></tr><tr><td><p>message</p><p><mark style="color:blue;">.sender</mark>*</p></td><td>String</td><td><p>Отправитель сообщения</p><p><em>!Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение</em></p></td></tr><tr><td><p>message</p><p>.<mark style="color:blue;">text</mark>*</p></td><td>String</td><td>Текст сообщения</td></tr><tr><td><p>message</p><p>.<mark style="color:blue;">phones</mark></p><p><mark style="color:orange;">.phone</mark>*</p></td><td>Int</td><td>Номер абонента, которому адресовано сообщение</td></tr><tr><td><p>message</p><p>.<mark style="color:blue;">phones</mark></p><p><mark style="color:orange;">.number_sms</mark></p></td><td>Int</td><td>Номер сообщения в пределах отправляемого XML документа</td></tr><tr><td><p>message</p><p>.<mark style="color:blue;">phones</mark></p><p><mark style="color:orange;">.client_id_sms</mark></p></td><td>Int</td><td><p>Число присваиваемое клиентом </p><p><em>!Необязательный параметр, позволяет избежать повторной отправки. Если раннее с этого аккаунта уже было отправлено</em> сообщение <em>с таким номером, то повторная отправка не производится, а возвращается номер ранее отправленного</em> сообщения</p></td></tr><tr><td><p></p><p>message</p><p>.<mark style="color:blue;">phones</mark></p><p><mark style="color:green;">validity_period</mark></p></td><td>date</td><td><p>Дата и время, после которых не будут делаться попытки доставить сообщение в формате:</p><p><em>YYYY-MM-DD HH:MM:SS</em></p><p>где,<br>    YYYY - год,<br>    MM - месяц,<br>    DD - день,<br>    HH - часы, </p><p>    MM - минуты</p><p>    SS - секунды</p><p><em>!Если не задано, то сообщение имеет максимальный срок жизни  (один день)</em></p></td></tr><tr><td><p>message</p><p>.<mark style="color:blue;">sender_viber</mark></p></td><td>String</td><td>Отправитель Viber сообщения</td></tr><tr><td><p>message</p><p>.<mark style="color:blue;">text_viber</mark></p></td><td>String</td><td>Текст Viber сообщения</td></tr><tr><td><p>message</p><p>.<mark style="color:blue;">button_viber</mark></p></td><td>String</td><td>Текст кнопки Viber сообщения</td></tr><tr><td><p>message</p><p>.<mark style="color:blue;">action_viber</mark></p></td><td>String</td><td>Ссылка для кнопки Viber сообщения</td></tr><tr><td><p>message</p><p>.<mark style="color:blue;">image_viber</mark></p></td><td>String</td><td>Адрес картинки для Viber сообщения</td></tr></tbody></table>

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

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

{% code fullWidth="false" %}

```json
{
    "information":
        [
            {
                "state": "Статус", 
                "id_sms": "ID SMS в системе для проверки статуса",
                "error": "Сообщение об ошибке."
            },
            {
                "state": "Статус", 
                "id_sms": "ID SMS в системе для проверки статуса",
                "error": "Сообщение об ошибке."
            }
        ]
}
```

{% endcode %}

<table><thead><tr><th width="189.66666666666666">Параметр</th><th width="107">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>information</p><p><mark style="color:green;">.state</mark></p></td><td>String</td><td>Статус сообщения («send»), если сообщение было отправлено</td></tr><tr><td><p>information</p><p><mark style="color:green;">.id_sms</mark></p></td><td>String</td><td><p>Номер сообщения. Используется для проверки статуса сообщения.</p><p><em>!Если в процессе отправки</em> сообщения <em>произошла ошибка, то id_sms не передается</em></p></td></tr><tr><td><p>information</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Сообщение об ошибке, если в процессе отправки произошла ошибка:</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></tbody></table>

### &#x20;В случае возникновения ошибки в отправленном JSON-документе

```json
{
    "error": "Текст ошибки."
}
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="115">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><mark style="color:blue;">error</mark></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат JSON документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```json
{
    "login":"логин",
    "password":"пароль",
    "token":"или токен",
    "message":
        [
            {
                "type_send_1":"sms",
                "sender":" Отправитель",
                "text":"Текст сообщения",
                "phones":
                    [
                        {
                            "phone":"79612242243",
                            "client_id_sms":"101",
                            "validity_period":"2001-12-31 15:34:54"
                        },
                        {
                            "phone":"79612242244",
                            "client_id_sms":"102",
                            "validity_period":"2001-12-31 15:34:54"
                        }
                    ]
            },
        ]
}
```

### &#x20;Пример JSON-документа для отправки Viber сообщения

```json
{
    "login":"логин",
    "password":"пароль",
    "token":"или токен",
    "message":
        [
            {
                "type_send_1": "viber",
                "sender_viber": "Отправитель",
                "text_viber": "Текст сообщения",
                "button_viber": "Текст кнопки",
                "action_viber": "Ссылка для кнопки",
                "image_viber": "Адресс картинки",
                "phones":
                    [
                        {
                            "phone":"79612242243",
                            "client_id_sms":"101",
                            "validity_period":"2001-12-31 15:34:54"
                        },
                        {
                            "phone":"79612242244",
                            "client_id_sms":"102",
                            "validity_period":"2001-12-31 15:34:54"
                        }
                    ]
            },
        ]
}
```

### &#x20;Пример JSON-документа для  отправки Каскадного сообщения

```json
{
    "login":"логин",
    "password":"пароль",
    "token":"или токен",
    "message":
        [
            {
                "type_send_1":"viber",
                "type_send_2":"sms",
                "sender":" Отправитель SMS",
                "text":"Текст сообщения SMS",
                "sender_viber": "Отправитель Viber",
                "text_viber": "Текст сообщения Viber",
                "button_viber": "Текст кнопки Viber",
                "action_viber": "Ссылка для кнопки Viber",
                "image_viber": "Адресс картинки Viber",
                "phones":
                    [
                        {
                            "phone":"79612242243",
                            "client_id_sms":"101",
                            "validity_period":"2001-12-31 15:34:54"
                        },
                        {
                            "phone":"79612242244",
                            "client_id_sms":"102",
                            "validity_period":"2001-12-31 15:34:54"
                        }
                    ]
            },
        ]
}
```

{% endtab %}

{% tab title="HTTP GET" %}
Метод отправки **`GET`**

Адрес для запроса: **`https://my3.webcom.mobi/sendsms.php`**

Все передаваемые значение необходимо закодировать.

### Примеры

[Пример отправки SMS сообщения<br>](#primer-zaprosa-dlya-otpravki-sms-soobsheniya)[Пример отправки Viber сообщения<br>](#primer-zaprosa-dlya-otpravki-viber-soobsheniya)[Пример отправки Каскадного сообщения](#primer-zaprosa-dlya-otpravki-kaskadnogo-soobsheniya)

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

<table><thead><tr><th width="207.66666666666666">Параметр</th><th width="87">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>user*</td><td>String</td><td>Ваш логин в системе</td></tr><tr><td>pwd<mark style="color:green;">*</mark></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td>token*</td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td>type_send_1*</td><td>String</td><td><p>Тип отправляемого сообщения </p><ul><li>viber </li><li>sms</li><li>flashcall</li><li>hlr</li></ul></td></tr><tr><td>type_send_2</td><td>String</td><td><p>Тип досылаемого сообщения, в случае если отправляемое сообщение не будет доставлено по первому типу направления <em>type_send_1</em>, применяется для каскадной отправки</p><ul><li>viber </li><li>sms</li></ul></td></tr><tr><td>sadr*</td><td>String</td><td><p>Отправитель сообщения</p><p><em>!Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение</em></p></td></tr><tr><td>dadr*</td><td>Int</td><td>Номер абонента, которому адресовано сообщение</td></tr><tr><td>text*</td><td>String</td><td>Текст сообщения</td></tr><tr><td>validity_period</td><td>date</td><td><p>Дата и время, после которых не будут делаться попытки доставить сообщение в формате:</p><p><em>YYYY-MM-DD HH:MM:SS</em></p><p>где,<br>    YYYY - год,<br>    MM - месяц,<br>    DD - день,<br>    HH - часы, </p><p>    MM - минуты</p><p>    SS - секунды</p><p><em>!Если не задано, то</em> сообщение <em>имеет максимальный срок жизни  (один день)</em></p></td></tr><tr><td>sender_viber</td><td>String</td><td>Отправитель Viber сообщения</td></tr><tr><td>text_viber</td><td>String</td><td>Текст Viber сообщения</td></tr><tr><td>button_viber</td><td>String</td><td>Текст кнопки Viber сообщения</td></tr><tr><td>action_viber</td><td>String</td><td>Ссылка для кнопки Viber сообщения</td></tr><tr><td>image_viber</td><td>String</td><td>Адрес картинки для Viber сообщения</td></tr></tbody></table>

### Ответ на GET запрос

В ответ будет направлен номер Viber сообщения **`id_sms`**. Используется для проверки статуса сообщения.

### Пример запроса для отправки SMS сообщения

{% code overflow="wrap" %}

```
https://my3.webcom.mobi/sendsms.php?user=ваш_логин_в_нашей_системе&pwd=пароль&sadr=от_кого_придет_СМС&dadr=номер_телефона_получателя_сообщения&text=текст_смс
```

{% endcode %}

### Пример запроса для отправки Viber сообщения

{% code overflow="wrap" %}

```
http://my3.webcom.mobi/sendsms.php?user=ваш_логин_в_нашей_системе&pwd=пароль&type_send_1=viber&sender_viber=от_кого_придет_сообщение&dadr=номер_телефона_получателя_сообщения&text_viber=текст_Viber_сообщения&button_viber=текст_кнопки_Viber_сообщения&action_viber=ссылка_для_кнопки_Viber_сообщения&image_viber=http://адрес_картинки_для_Viber_сообщения
```

{% endcode %}

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

{% code overflow="wrap" %}

```
http://my3.webcom.mobi/sendsms.php?user=ваш_логин_в_нашей_системе&pwd=пароль&sadr=от_кого_придет_СМС&dadr=номер_телефона_получателя_смс&text=текст_смс&type_send_1=viber&sender_viber=от_кого_придет_сообщение&text_viber=текст_Viber_сообщения&button_viber=текст_кнопки_Viber_сообщения&action_viber=ссылка_для_кнопки_Viber_сообщения&image_viber=http://адрес_картинки_для_Viber_сообщения
```

{% endcode %}
{% endtab %}
{% endtabs %}


# Проверка статуса сообщения

Существует два способа получить информацию о статусах SMS

{% content-ref url="/pages/ECtFpM7lmVGvkuJxrmar" %}
[POST запрос](/ru/proverka-statusa-soobsheniya/post-zapros)
{% endcontent-ref %}

{% content-ref url="/pages/U407Gwy7OwVVjYW3HH1g" %}
[Webhook](/ru/proverka-statusa-soobsheniya/webhook)
{% endcontent-ref %}


# POST запрос

Спецификации для запроса статуса: JSON, XML, HTTP GET

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.get_state</mark></p><p><mark style="color:blue;">.id_sms</mark>*</p></td><td>Int</td><td>Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения.</td></tr></tbody></table>

&#x20;\*- обязательный параметр

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46" sms="Статус">Статус</state>
     <state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46" sms="Статус" viber="Статус">Статус</state>
     <state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46" viber="Статус">Статус</state>
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p><p><mark style="color:green;">[id_sms]</mark></p></td><td>Int</td><td>Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p><p><mark style="color:green;">[time]</mark></p></td><td>Date</td><td>Время изменения статуса</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p></td><td>String</td><td><p>Последний статус сообщения:</p><ul><li>«send» - статус сообщения не получен. В этом случае передается пустой time (time="")</li><li>«not_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем)</li><li>«expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный статус (не меняется со временем)</li><li>«deliver» - сообщение доставлено.</li><li>«read» - сообщение прочитано. Конечный статус (не меняется со временем) <em>для viber сообщения</em></li><li>«partly_deliver» - сообщение было отправлено, но статус так и не был получен</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p><p><mark style="color:green;">[sms]</mark></p></td><td>String</td><td>Статус SMS сообщения. </td></tr><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p><p><mark style="color:green;">[viber]</mark></p></td><td>String</td><td>Статус Viber сообщения. </td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
    <get_state>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
    </get_state>
</request>
```

{% endtab %}

{% tab title="JSON" %}
Метод отправки **`POST`**

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

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

Адрес для запроса: **`https://my3.webcom.mobi/json/state.php`**

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>login*</td><td>String</td><td>Ваш логин в системе</td></tr><tr><td>password*</td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td>token*</td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td>id_sms*</td><td>Int</td><td>Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения.</td></tr><tr><td>detail</td><td>Int</td><td>0 или 1 в случае необходимости получения кол-во частей и цены за одну часть сообщения</td></tr></tbody></table>

&#x20;\*- обязательный параметр

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

```json
[
    {
        "id_sms": 82216,
        "time_change_state": "2021-04-26 15:15:03",
        "state": "deliver",
        "num_parts": 1,
        "price": 10.6000000
    }
]
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>id_sms</td><td>Int</td><td>Номер сообщения, полученный в ответном JSON-документа в процессе отправки сообщения</td></tr><tr><td>time_change_state</td><td>Date</td><td>Время изменения статуса</td></tr><tr><td>state</td><td>String</td><td><p>Последний статус сообщения:</p><ul><li>«send» - статус сообщения не получен. В этом случае передается пустой time (time="")</li><li>«not_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем)</li><li>«expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный статус (не меняется со временем)</li><li>«deliver» - сообщение доставлено.</li><li>«read» - сообщение прочитано. Конечный статус (не меняется со временем) <em>для viber сообщения</em></li><li>«partly_deliver» - сообщение было отправлено, но статус так и не был получен</li></ul></td></tr><tr><td>num_parts</td><td>String</td><td>Количество частей SMS</td></tr><tr><td>price</td><td>String</td><td>Цена за одну часть SMS</td></tr></tbody></table>

### &#x20;В случае возникновения ошибки в отправленном JSON-документе

```json
{
    "error": "Текст ошибки."
}
```

<table><thead><tr><th width="188.66666666666663">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>error</td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат JSON документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

### &#x20;Пример JSON запроса

```json
{
  "login": "логин",
  "password": "пароль",
  "token":"токен",
  "id_sms": ID SMS в системе для проверки статуса,
  "detail" : 1
}
```

{% endtab %}

{% tab title="HTTP GET" %}
Метод отправки **`GET`**

Адрес для запроса: **`https://my3.webcom.mobi/sendsms.php`**

Все передаваемые значение необходимо закодировать.

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>user*</td><td>String</td><td>Ваш логин в системе</td></tr><tr><td>pwd*</td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td>token*</td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td>smsid*</td><td>Int</td><td>Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения.</td></tr></tbody></table>

&#x20;\*- обязательный параметр

### Ответ на GET запрос

В ответ придет состояние **`state`** по переданному **`smsid`**, варианты ответа в таблице ниже.

### Ответ GET запроса статуса <a href="#otvet-get-zaprosa-statusa" id="otvet-get-zaprosa-statusa"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>state</td><td>String</td><td><p>Последний статус сообщения:</p><ul><li>«send» - статус сообщения не получен. В этом случае передается пустой time (time="")</li><li>«not_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем)</li><li>«expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный статус (не меняется со временем)</li><li>«deliver» - сообщение доставлено.</li><li>«read» - сообщение прочитано. Конечный статус (не меняется со временем) <em>для viber сообщения</em></li><li>«partly_deliver» - сообщение было отправлено, но статус так и не был получен</li></ul></td></tr></tbody></table>

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

{% code overflow="wrap" %}

```
http://lk.mysmpp.ru/sendsms.php?user=пользователь&pwd=пароль&smsid=ID_SMS
```

{% endcode %}
{% endtab %}
{% endtabs %}


# Webhook

Необходимо сообщить менеджеру адрес вашего сервера, который будет принимать статусы сообщений

Спецификации для отправки JSON и XML

{% tabs %}
{% tab title="XML" %}
Метод отправки XML-документа: **`POST`**

К примеру, в **phpXML**-документ будет доступен через переменную **`$GLOBALS['HTTP_RAW_POST_DATA']`**

Система отправляет XML-документ серверу клиента следующего содержания:

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <state id_sms="IDSMS в системе для проверки статуса" time="2011-01-01 12:57:46" sms="Статус">Статус</state>
     <state id_sms="IDSMS в системе для проверки статуса" time="2011-01-01 12:57:46" sms="Статус" viber="Статус">Статус</state>
     <state id_sms="IDSMS в системе для проверки статуса" time="2011-01-01 12:57:46" viber="Статус">Статус</state>
</response>
```

### &#x20;Расшифровка параметров

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p><p><mark style="color:green;">[id_sms]</mark></p></td><td>Int</td><td>Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p><p><mark style="color:green;">[time]</mark></p></td><td>Date</td><td>Время изменения статуса</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p></td><td>String</td><td><p>Последний статус сообщения:</p><ul><li>«send» - статус сообщения не получен. В этом случае передается пустой time (time="")</li><li>«not_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем)</li><li>«expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный статус (не меняется со временем)</li><li>«deliver» - сообщение доставлено.</li><li>«read» - сообщение прочитано. Конечный статус (не меняется со временем) <em>для viber сообщения</em></li><li>«partly_deliver» - сообщение было отправлено, но статус так и не был получен</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p><p><mark style="color:green;">[sms]</mark></p></td><td>String</td><td>Статус SMS сообщения. </td></tr><tr><td><p>response</p><p><mark style="color:blue;">.state</mark></p><p><mark style="color:green;">[viber]</mark></p></td><td>String</td><td>Статус Viber сообщения. </td></tr></tbody></table>

### &#x20;Возвращаемый ответ сервера клиента в XML-документе

{% hint style="warning" %}
Если сервер клиента не передаст **id\_sms**, то статус будет считаться не полученным клиентом. При этом будет сделано 5 попыток доставить статус.
{% endhint %}

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <id_sms>3234</id_sms>
     <id_sms>3235</id_sms>
</response>
```

{% endtab %}

{% tab title="JSON" %}
Метод отправки JSON-документа: **`POST`**

К примеру, в php JSON-документ будет доступен через функцию **`file_get_contents("php://input")`** или переменную **`$GLOBALS['HTTP_RAW_POST_DATA']`**

Система отправляет JSON-документ серверу клиента следующего содержания:

```json
[
    {
        "id_sms": "ID SMS в системе для проверки статуса",
        "time": "2011-01-01 12:57:46",
        "state": "Статус"
        },
    {
        "id_sms": "ID SMS в системе для проверки статуса",
        "time": "2011-01-01 12:57:46",
        "state": "Статус"
    }
]
```

### &#x20;Расшифровка параметров

<table><thead><tr><th width="151.66666666666666">Параметр</th><th width="115">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>id_sms</td><td>Int</td><td>Номер сообщения, полученный в ответном JSON-документа в процессе отправки сообщения</td></tr><tr><td>time</td><td>Date</td><td>Время изменения статуса</td></tr><tr><td>state</td><td>String</td><td><p>Последний статус сообщения:</p><ul><li>«send» - статус сообщения не получен. В этом случае передается пустой time (time="")</li><li>«not_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем)</li><li>«expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный статус (не меняется со временем)</li><li>«deliver» - сообщение доставлено.</li><li>«read» - сообщение прочитано. Конечный статус (не меняется со временем) для viber сообщения</li><li>«partly_deliver» - сообщение было отправлено, но статус так и не был получен</li></ul></td></tr></tbody></table>

### &#x20;Возвращаемый ответ сервера клиента в JSON-документе

{% hint style="warning" %}
Если сервер клиента не передаст **id\_sms**, то статус будет считаться не полученным клиентом. При этом будет сделано 5 попыток доставить статус.
{% endhint %}

```json
[
    {
        "id_sms":3234
    },
    {
        "id_sms":3235
    }
]
```

{% endtab %}
{% endtabs %}


# Проверка баланса

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

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <money>150</money>
     <sms area="Россия">111</sms>
     <sms area="Украина">111</sms>
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.money</mark></p></td><td>Int</td><td>Остаток средств</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p></td><td>Int</td><td>Количество доступных SMS сообщений для данного направления</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p><p><mark style="color:green;">[area]</mark></p></td><td>String</td><td>Направление, в котором может быть отправлено данное количество сообщений</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
   <security>
      <login value="логин" />
      <password value="пароль" />
   </security>
</request>
```

{% endtab %}

{% tab title="JSON" %}
Метод отправки **`POST`**

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

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

Адрес для запроса: **`https://my3.webcom.mobi/json/balance.php`**

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>login*</td><td>String</td><td>Ваш логин в системе</td></tr><tr><td>password*</td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td>token*</td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr></tbody></table>

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

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

```json
{
    "money": "19023.9",
    "currency": "RUR",
    "information": 
        [
            {
                "type_sms": "sms",
                "area": "Tele2",
                "num_sms": "72029"
            }, 
            {
                "type_sms": "sms",
                "area": "Россия",
                "num_sms": "Безлимит"
            }
        ]
}
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>money</td><td>Int</td><td>Остаток средств</td></tr><tr><td>currency</td><td>String</td><td>Валюта</td></tr><tr><td><p>information</p><p>.type_sms</p></td><td>String</td><td>Тип сообщения</td></tr><tr><td><p>information</p><p>.area</p></td><td>String</td><td>Направление, в котором может быть отправлено данное количество сообщений</td></tr><tr><td><p>information</p><p>.num_sms</p></td><td>Int/String</td><td>Количество доступных сообщений для данного направления</td></tr></tbody></table>

### &#x20;В случае возникновения ошибки в отправленном JSON-документе

```json
{
    "error": "Текст ошибки."
}
```

<table><thead><tr><th width="289.66666666666663">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>error</td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат JSON документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

### &#x20;Пример JSON запроса

```json
{
    "login": "логин",
    "password": "пароль",
}
```

{% endtab %}
{% endtabs %}


# Регистрация

Спецификации для регистрации: HTTP GET

{% hint style="info" %}
Набор параметров для регистрации физического лица, юридического лица и индивидуального предпринимателя различаются
{% endhint %}

{% tabs %}
{% tab title="HTTP GET" %}
Метод отправки **`GET`**

Адрес для запроса: **`https://my3.webcom.mobi/sendsms.php`**

Все передаваемые значение необходимо закодировать.

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

<table><thead><tr><th width="207.66666666666666">Параметр</th><th width="87">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>user*</td><td>String</td><td>Ваш логин в системе</td></tr><tr><td>pwd*</td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td>token*</td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td>registration</td><td>String</td><td>Параметр регистрации, всегда «1»</td></tr><tr><td>businessman</td><td>String</td><td><p>Тип регистрируемого лица:</p><p>  - «le» - Юридическое лицо</p><p>  - «ip» - Индивидуальный предприниматель</p><p>  - «le» - Физическое лицо</p></td></tr><tr><td>login</td><td>String</td><td>Логин клиента в системе</td></tr><tr><td>password</td><td>String</td><td>Пароль клиента в системе</td></tr><tr><td>name</td><td>String</td><td><p>ФИО клиента</p><p><mark style="color:red;">Не менее 3 символов, должно состоять из русских или латинских символов</mark></p></td></tr><tr><td>city</td><td>Int</td><td><p>Страна/Город клиента</p><p><mark style="color:red;">Не менее 3 символов</mark></p></td></tr><tr><td>phone</td><td>Int</td><td>Номер телефона клиента</td></tr><tr><td>e_mail</td><td>Int</td><td><p>E-mail клиента
</p><p><mark style="color:red;">E-mail соответствующего формата</mark></p></td></tr><tr><td>inn</td><td>date</td><td><p>ИНН клиента (ЮЛ, ИП)</p><p><mark style="color:red;">Не менее 10 цифр</mark></p></td></tr><tr><td>juridical_address</td><td>date</td><td><p>Юридический адрес (ЮЛ, ИП)</p><p><mark style="color:red;">Не менее 10 символов</mark></p></td></tr><tr><td><p></p><p>company_name</p></td><td>date</td><td><p>Наименование компании (ЮЛ</p><p><mark style="color:red;">Не менее 5 символов</mark></p></td></tr><tr><td>ogrnip</td><td>String</td><td><p>ОГРНИП клиента (ИП)</p><p><mark style="color:red;">Должен содержать 13-15 цифр</mark></p></td></tr><tr><td>address_facto</td><td>String</td><td><p>Фактический адрес (ФЛ)</p><p><mark style="color:red;">Не менее 10 символов</mark></p></td></tr></tbody></table>

### &#x20;Пример GET запроса

{% code overflow="wrap" %}

```
http://lk.mysmpp.ru/ru/reg/registration.html?registration=1&businessman=le&login=user&password=password&name=Ivan&city=City&phone=79537775522&e_mail=registration@gmail.com&inn=5551112223&juridical_address=Московская24&company_name=nameCompany
```

{% endcode %}
{% endtab %}
{% endtabs %}


# Получение списка отправителей

Спецификация для получения списка отправителей: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <any_originator>FALSE</any_originator>
     <list_originator>
          <originator MCC="МСС" MNC="МНС" template="шаблон" comment="комментарий" history="комментарий" operator="оператор" state="rejected" type_sending="sms" type_traffic="multi">Отправитель</originator>
     </list_originator>
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.any_originator</mark></p></td><td>String</td><td><p>TRUE/FALSE - может ли клиент отправлять от любого отправителя или только от заранее одобренных. </p><ul><li>Если TRUE, то клиент может использовать любого отправителя. При этом список отправителей не возвращается. </li><li>Если FALSE, то клиент может использовать только отправителей со статусом «ready»</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[state]</mark></p></td><td>String</td><td><p>Статус отправителя:</p><ul><li>«order» – оформляется</li><li>«ready» - готов к использованию</li><li>«rejected» – отклонен</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[mcc]</mark></p></td><td>String</td><td>Мобильный код страны</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[mnc]</mark></p></td><td>String</td><td>Мобильный код оператора</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[template]</mark></p></td><td>String</td><td>Наименование шаблона</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[comment]</mark></p></td><td>String</td><td>Комментарий клиента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[history]</mark></p></td><td>String</td><td>Комментарий менеджера</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[operator]</mark></p></td><td>String</td><td>Используемое направление</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[type_sending]</mark></p></td><td>String</td><td><p>Тип отправителя. Возможные значения: </p><ul><li>sms</li><li>flashsms </li><li>wappush </li><li>vcard</li><li>silence</li><li>viber</li><li>vk</li><li>telegram </li><li>whatsapp</li><li>skype </li><li>facebook </li><li>e_mail</li><li>voice</li><li>voice_ivr </li><li>hlr</li><li>pingsms</li><li> flashcall</li><li>twitter </li><li>instagram </li><li>hangouts </li><li>yandex </li><li>icq</li><li>wechat</li><li>qq</li><li>snapchat </li><li>discord</li><li>line</li><li>hlr_whatsapp </li><li>hlr_telegram</li><li>hlr_viber </li><li>hlr_voice</li><li>hlr_voice_ivr</li><li>hlr_flashcall</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[type_traffic]</mark></p></td><td>String</td><td><p>Тип трафика. Возможные значения </p><ul><li>multi</li><li>transaction</li><li>service</li><li>commercial </li><li>authorization</li></ul></td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
   <security>
      <login value="логин" />
      <password value="пароль" />
   </security>
</request>
```

{% endtab %}
{% endtabs %}


# Добавление отправителей

{% hint style="info" %}
Отправитель может состоять только из 11-ти латинских символов, цифр, пробелов и знаков "'?><,.-\_=+/"!@#$%^&\*() " или 15-ти цифр
{% endhint %}

Спецификация для добавления отправителей: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="210">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.originator</mark>*</p></td><td>String</td><td>Отправитель, которого нужно добавить</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.originator</mark></p><p><mark style="color:green;">[inn]</mark></p></td><td>Int</td><td>ИНН организации</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.originator</mark></p><p><mark style="color:green;">[kpp]</mark></p></td><td>Int</td><td>КПП организации</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.originator</mark></p><p><mark style="color:green;">[ogrn]</mark></p></td><td>Int</td><td>ОГРН организации</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.originator</mark></p><p><mark style="color:green;">[name_counterparty]</mark></p></td><td>String</td><td>Имя контрагента</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.originator</mark></p><p><mark style="color:green;">[template]</mark></p></td><td>String</td><td>Текст шаблона</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.originator</mark></p><p><mark style="color:green;">[comment]</mark></p></td><td>String</td><td>Комментарий</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.operator</mark></p><p><mark style="color:green;">[mcc]</mark></p></td><td>Int</td><td>Мобильный код страны</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.operator</mark></p><p><mark style="color:green;">[mnc]</mark></p></td><td>Int</td><td>Мобильный код оператора</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.file</mark></p><p><mark style="color:green;">[href]</mark></p></td><td>String</td><td>Ссылка на загружаемый файл</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.file</mark></p><p><mark style="color:green;">[id]</mark></p></td><td>Int</td><td>Id загружаемого файла</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <originator id_originator="">Отправитель поставлен в очередь на регистрацию.</originator>
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.originator</mark></p></td><td>String</td><td><p>Результат добавления отправителя. Может содержать следующие значения:</p><ul><li>Отправитель добавлен.</li><li>Отправитель поставлен в очередь на регистрацию. </li><li>Отправитель может состоять только из 11-ти латинских символов, цифр, пробелов и знаков "\'?>&#x3C;,.-_=+/"!@#$%^&#x26;*() " или 15-ти цифр</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.originator</mark></p><p><mark style="color:green;">[id_originator]</mark></p></td><td>Int</td><td>Уникальный номер отправителя в системе</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
    <originator INN="ИНН" KPP="КПП" OGRN="ОГРН" name_counterparty="имя контрагента" template="текст шаблона" comment="комментарий">Отправитель</originator>
    <operator MCC="" MNC=""/>
    …
    <operator MCC="" MNC=""/>
    <file href="http://..." id="1" />
    …
    <file href="http://..." id="4" />
</request>
```

{% endtab %}
{% endtabs %}


# Получение входящих сообщений

Спецификация для получения входящих сообщений: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.time</mark></p><p><mark style="color:green;">[start]</mark>*</p></td><td>Date</td><td>Время (не включительно), с которого запрашиваются входящие сообщения</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.time</mark></p><p><mark style="color:green;">[end]</mark></p></td><td>Date</td><td><p>Время (не включительно), по которое запрашиваются входящие сообщения. </p><p><mark style="color:orange;">Если не задан, то будут возвращены все смс</mark></p></td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <sms id_sms="1234" date_receive="2012-01-31 12:55:55" originator="79612242243" prefix="IGRA" phone="79611111111">Текст</sms>
     <sms id_sms="1234" date_receive="2012-01-31 12:55:55" originator="79612242243" prefix="IGRA" phone="79611111111">Текст</sms>
     …
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p></td><td>String</td><td>Входящее сообщение</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p><p><mark style="color:green;">[id_sms]</mark></p></td><td>Int</td><td>Уникальный номер, состоящий только из цифр</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p><p><mark style="color:green;">[date_receive]</mark></p></td><td>Date</td><td>Дата и время получения сообщения</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p><p><mark style="color:green;">[originator]</mark></p></td><td>Int</td><td>Номер телефона абонента, отправившего</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p><p><mark style="color:green;">[prefix]</mark></p></td><td>String</td><td>Префикс. Начальная часть текста SMS, по которой было определено, что эта SMS принадлежит именно этому клиенту. (Используется если один и тот же номер используется разными клиентами.)</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p><p><mark style="color:green;">[phone]</mark></p></td><td>Int</td><td>Номер телефона, на который была отправлено сообщение</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<request>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
    <time start="2012-01-31 12:23:00" end="2012-02-31 12:23:00" />
</request>
```

{% endtab %}
{% endtabs %}


# Получение информации по номеру телефона

Спецификация для получения информации по номеру телефона: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark>*</p></td><td>Int</td><td>Номер телефона</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <phone operator="Вымпелтелеком" region="Новосибирскаяобласть" time_zone="3">79612242243</phone>
     <phone operator="Вымпелтелеком" region="Калининград" time_zone="-1">79612242244</phone>
…
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.phone</mark></p></td><td>Int</td><td>Номер телефона</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phone</mark></p><p><mark style="color:green;">[operator]</mark></p></td><td>String</td><td>Оператор</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phone</mark></p><p><mark style="color:green;">[region]</mark></p></td><td>String</td><td>Регион</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phone</mark></p><p><mark style="color:green;">[time_zone]</mark></p></td><td>Date</td><td>Смещение времени в часах относительно времени в Москве</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
         <login value="логин" />
         <password value="пароль" />
     </security>
     <phones>
         <phone>79612242243</phone>
         <phone>79612242244</phone>
     </phones>
</request>
```

{% endtab %}
{% endtabs %}


# Получение списка баз

Спецификация для получения списка баз: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <base id_base="1234" name_base="База главного офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
     <base id_base="1235" name_base="База Московского офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
     …
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p></td><td>String</td><td>Текст поздравления</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[id_base]</mark></p></td><td>Int</td><td>Уникальный номер базы в системе</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[name_base]</mark></p></td><td>String</td><td>Название базы</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[time_birth]</mark></p></td><td>Time</td><td>Время поздравления</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[local_time_birth]</mark></p></td><td>String</td><td>Считать время поздравления относительно местного времени абонента(<strong><code>yes</code></strong>) или относительно времени системы (<strong><code>no</code></strong>)</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[day_before]</mark></p></td><td>Int</td><td>За сколько дней до дня рождения поздравлять</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[originator_birth]</mark></p></td><td>String</td><td>Отправитель поздравления</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[on_birth]</mark></p></td><td>String</td><td><p>Включены ли поздравления:</p><ul><li>yes – включены </li><li>no - выключены</li></ul></td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
   <security>
      <login value="логин" />
      <password value="пароль" />
   </security>
</request>
```

{% endtab %}
{% endtabs %}


# Изменение параметров, добавление/удаление баз

Спецификация для изменения параметров, добавления/удаления баз: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="210">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark>*</p></td><td>String</td><td>Текст поздравления</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[id_base]</mark></p></td><td>Int</td><td><p>Уникальный номер базы в системе. </p><p><mark style="color:orange;">Если не указан произойдет добавление базы. При этом нужно указать параметр <strong>number_base</strong></mark></p></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[number_base]</mark></p></td><td>Int</td><td>Номер базы в XMLзапросе. Указывается только при создании новой базы. Используется для сопоставления ID добавленных баз (если их было несколько в запросе)</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[name_base]</mark></p></td><td>Int</td><td>Название базы</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[time_birth]</mark></p></td><td>Time</td><td>Время поздравления</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[local_time_birth]</mark></p></td><td>String</td><td>Считать время поздравления относительно местного времени абонента (<strong><code>yes</code></strong>) или относительно времени системы (<strong><code>no</code></strong>)</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[originator_birth]</mark></p></td><td>String</td><td>Отправитель поздравления</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[on_birth]</mark></p></td><td>Int</td><td><p>Включены ли поздравления:</p><ul><li>yes – включены </li><li>no - выключены</li></ul></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.delete_bases</mark></p><p>.<mark style="color:green;">base</mark></p><p><mark style="color:orange;">[id_base]</mark></p></td><td>Int</td><td>Уникальный номер базы в системе, который необходимо удалить</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <base id_base=”1234”>edit</base>
     <base number_base=”1” id_base=”1235”>insert</base>
     <base number_base=”2” id_base=”1236”>edit</base>
     <base id_base=”1235”>delete</base>
     <base id_base=”1235”>not_found</base>
…
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p></td><td>Sting</td><td>Действие</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[id_base]</mark></p></td><td>Int</td><td>Уникальный номер базы в системе. </td></tr><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[number_base]</mark></p></td><td>Int</td><td>Номер базы в XML запросе. Указывается только при создании новой базы. Используется для сопоставления ID добавленных баз (если их было не сколько в запросе)</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
     <bases>
          <base id_base="1234" name_base="База главного офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
          <base number_base="1" name_base="База Московского офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
     </bases>
     <delete_bases>
          <base id_base="1235" />
          <base id_base="1236" />
          …
     </delete_bases>
</request>
```

{% endtab %}
{% endtabs %}


# Получение списка абонентов базы

Спецификация для получения списка абонентов баз: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[id_base]</mark>*</p></td><td>Int</td><td>Номер базы в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[page]</mark>*</p></td><td>Int</td><td><p>Номер страницы. </p><p>Весь список номеров базы делится на страницы. Запросить целиком базу нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички</p></td></tr><tr><td><p>request</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[last_update]</mark></p></td><td>Date</td><td>Минимальная дата и время регистрации (или последнего изменения) данных абонента, которых Вам нужно запросить</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <phones page="1" num_pages="100">
          <phone phone="79612242243" region="Новосибирск" operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" male="m" addition_1="Первое дополнительное поле" addition_2="второе" last_update=” 2011-03-25 08:39:48” />
          <phone phone="79612242244" region="Новосибирск" operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" male="m" addition_1="Первое дополнительное поле" addition_2="второе" last_update=” 2011-03-25 08:39:48” />
          …
     </phones>
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">[page]</mark></p></td><td>Int</td><td>Номер страницы</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">[num_pages]</mark></p></td><td>Int</td><td>Всего страниц</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[phone]</mark></p></td><td>Int</td><td>Номер телефона абонента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[region]</mark></p></td><td>String</td><td>Регион</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[operator]</mark></p></td><td>String</td><td>Оператор</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[name]</mark></p></td><td>String</td><td>Имя абонента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[surname]</mark></p></td><td>String</td><td>Фамилия абонента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[patronymic]</mark></p></td><td>String</td><td>Отчество абонента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[date_birth]</mark></p></td><td>Date</td><td>Дата рождения</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[male]</mark></p></td><td>String</td><td><p>Пол:</p><ul><li>«f»- женский</li><li>«m» - мужской </li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[addition_1]</mark></p></td><td>String</td><td>Первое дополнительное поле</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[addition_2]</mark></p></td><td>String</td><td>Второе дополнительное поле</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[last_update]</mark></p></td><td>Date</td><td>Дата и время регистрации (или последнего изменения) данных абонента</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
    <security>
        <login value="логин" />
        <password value="пароль" />
    </security>
    <base id_base="1234" page=”1” last_update=”2011-03-25 08:39:48”/>
</request>
```

{% endtab %}
{% endtabs %}


# Добавление/редактирование/удаление абонентов базы

Спецификация для добавления/редактирования/удаления абонентов базы: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="176">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[id_base]</mark>*</p></td><td>Int</td><td>Номер базы в системе</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[phone]</mark>*</p></td><td>Int</td><td><p>Номер телефона абонента. </p><p><em>Если абонент с таким номером уже существует, то он будет о</em>тредактирован</p></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[region]</mark></p></td><td>String</td><td><p>Регион. </p><p><em>Если не задано определяется автоматиче</em>ски</p></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[operator]</mark></p></td><td>String</td><td><p>Оператор. </p><p><em>Если не задано определяется автоматически.</em></p></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[name]</mark></p></td><td>String</td><td>Имя абонента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[surname]</mark></p></td><td>String</td><td>Фамилия абонента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[patronymic]</mark></p></td><td>String</td><td>Отчество абонента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[date_birth]</mark></p></td><td>Date</td><td>Дата рождения</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[male]</mark></p></td><td>String</td><td><p>Пол:</p><ul><li>«f»- женский</li><li>«m» - мужской </li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[addition_1]</mark></p></td><td>String</td><td>Первое дополнительное поле</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[addition_2]</mark></p></td><td>String</td><td>Второе дополнительное поле</td></tr><tr><td><p>sponse</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[number_phone]</mark></p></td><td>Int</td><td>Порядковый номер телефона в системе</td></tr><tr><td><p>sponse</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[action]</mark></p></td><td>String</td><td>В случае необходимости удаления "delete"</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <base id_base="1234">
          <phone phone="79612242243" number_phone="1"/>insert</phone>
          <phone phone="79612242244" number_phone="2" />edit</phone>
          <phone phone="79612242243" number_phone="5"/>delete</phone>
          <phone phone="79612242244" number_phone="6" />not_found</phone>
     </base>
     …
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.base</mark></p><p><mark style="color:green;">[id_base]</mark></p></td><td>Int</td><td>Номер базы в системе</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p></td><td>String</td><td>Выполненное действие</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[phone]</mark></p></td><td>Int</td><td>Номер телефона абонента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[number_phone]</mark></p></td><td>Int</td><td>Порядковый номер телефона в систем</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
     <base id_base="1234">
          <phone phone="79612242243" region="Новосибирск" operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" male="мужской" addition_1="Первое дополнительное поле" addition_2="второе" number_phone="1"/>
          <phone phone="79612242244" region="Новосибирск" operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" male="мужской" addition_1="Первое дополнительное поле" addition_2="второе" number_phone="2" />
          …
          <phone phone="79612242243" action="delete" number_phone="5"/>
          <phone phone="79612242244" action="delete" number_phone="6"/>
     </base>
</request>
```

{% endtab %}
{% endtabs %}


# Получение списка номеров из СТОП-листа

Спецификации для получение списка номеров из СТОП-листа: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <phone>79612242243</phone>
     <phone>79612242244</phone>
     …
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.phone</mark></p></td><td>Int</td><td>Номер телефона</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
   <security>
      <login value="логин" />
      <password value="пароль" />
   </security>
</request>
```

{% endtab %}
{% endtabs %}


# Добавление/удаление абонентов в СТОП-лист

Спецификации для добавления/удаления абонентов в СТОП-лист: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:green;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.add_stop</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[phone]</mark></p></td><td>Int</td><td>Номер телефона абонента, которого нужно добавить в СТОП-лист</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.delete_stop</mark></p><p><mark style="color:green;">.phone</mark></p><p><mark style="color:orange;">[phone]</mark></p></td><td>Int</td><td>Номер телефона абонента, которого нужно удалить из СТОП-листа</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
    <phone phone="79612242243">delete</phone>
    <phone phone="79612242244">add</phone>
    <phone phone="79612242245">not_found</phone>
    …
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.phone</mark></p></td><td>String</td><td>Выполненное действие</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phone</mark></p><p><mark style="color:green;">[phone]</mark></p></td><td>Int</td><td>Номер телефона</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
     <add_stop>
          <phone phone="79612242243" />
          <phone phone="79612242244" />
          …
     </add_stop>
     <delete_stop>
          <phone phone="79612242243" />
          <phone phone="79612242244" />
          …
     </delete_stop>
</request>
```

{% endtab %}
{% endtabs %}


# Получение списка запланированных сообщений

Спецификации для получение списка запланированных сообщений: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:green;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.scheduled</mark></p><p><mark style="color:green;">.[page]</mark></p></td><td>Int</td><td><p>Номер страницы. </p><p><em>Весь список запланированных сообщений делится на страницы. Запросить список целиком нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с едини</em>чки</p></td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <phones page="1" num_pages="100">
          <scheduled id_sms="1234" time_put_turn="2011-11-14 12:42:40" originator="kosty" phone="79612242243" type_sms="sms" text_sms="Текст SMS" count_sms="2" name_delivery="Название расылки" time_send="2011-11-14 21:00" validity_period="2011-11-17 21:00:00" />
          <scheduled id_sms="1235" time_put_turn="2011-11-14 12:42:40" originator="kosty" phone="79612242244" type_sms="sms" text_sms="Текст SMS" count_sms="2" name_delivery="Название расылки" time_send="2011-11-14 21:00" validity_period="2011-11-17 21:00:00" />
          …
     </phones>
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">[page]</mark></p></td><td>Int</td><td>Номер страницы</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">[num_pages]</mark></p></td><td>Int</td><td>Всего страниц</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[id_sms]</mark></p></td><td>Int</td><td><p>Номер сообщения. </p><p><em>Используется для удаления запланированного сообщения</em></p></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[time_put_turn]</mark></p></td><td>Date</td><td>Время добавления в планировщик</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[originator]</mark></p></td><td>String</td><td><p>Отправитель сообщения. </p><p><em>Именно это значение будет выводиться на телефоне абонента в поле от кого сообщение</em></p></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[phone]</mark></p></td><td>Int</td><td>Номер абонента, которому адресовано сообщение</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[type_sms]</mark></p></td><td>String</td><td><p>Тип SMS сообщения:</p><ul><li>viber </li><li>sms</li><li>flashcall</li><li>hlr</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[text_sms]</mark></p></td><td>String</td><td>Текст сообщения</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[count_sms]</mark></p></td><td>Int</td><td>Количество частей сообщения</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[name_delivery]</mark></p></td><td>String</td><td>Название рассылки</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[time_send]</mark></p></td><td>Date</td><td><p>Дата и время отправки в формате:</p><p>YYYY-MM-DD HH:MM</p><p>где,<br>   YYYY-год,<br>   MM-месяц,<br>   DD-день,<br>   HH-часы, </p><p>   MM-минуты</p></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[validity_period]</mark></p></td><td>Date</td><td><p>Дата и время, после которых не будут делаться попытки доставить SMS в формате:</p><p>  YYYY-MM-DD HH:MM:SS</p><p>где,<br>   YYYY-год,<br>   MM-месяц,<br>   DD-день,<br>   HH-часы, </p><p>   MM-минуты</p><p>   SS-секунды</p></td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
     <scheduled page=”1”/>
</request>
```

{% endtab %}
{% endtabs %}


# Удаление запланированного сообщения

Спецификации для удаление запланированного сообщения: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="218">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:green;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.delete_scheduled</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[id_sms]</mark></p></td><td>Int</td><td><p>Номер запланированного сообщения, которое нужно удалить. </p><p><em>Можно получить при запросе списка запланированных SMS</em></p></td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
    <scheduled id_sms="1234">delete</scheduled>
    <scheduled id_sms="1235">not_found</scheduled>
    …
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p></td><td>String</td><td>Выполненное действие</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.phones</mark></p><p><mark style="color:green;">.scheduled</mark></p><p><mark style="color:orange;">[id_sms]</mark></p></td><td>Int</td><td>Номер сообщения</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
     <delete_schedule>
          <schedule id_sms="1234" />
          <schedule id_sms="1235" />
          …
     </delete_schedule>
</request>
```

{% endtab %}
{% endtabs %}


# Получение времени изменения чего-либо

Спецификации для получение времени изменения чего-либо: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.check</mark></p><p>[obgect]*</p></td><td>String</td><td>Тип объекта: база данных (<strong><code>base</code></strong>), стоп лист (<strong><code>stop</code></strong>)</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.check</mark></p><p><mark style="color:green;">[id]</mark>*</p></td><td>Int</td><td>Уникальный номер объекта</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
    <obgect time_update="2012-01-01 12:12:12" />
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.obgect</mark></p><p><mark style="color:green;">[time_update]</mark></p></td><td>Date</td><td>Время последнего изменения объекта</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
     <check obgect="base" id="1"/>
</request>
```

{% endtab %}
{% endtabs %}


# Проверка времени

Спецификации для проверки времени: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <time>15:34:05</time>
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.time</mark></p></td><td>Time</td><td><p>Локальное время пользователя</p><p><em>При этом время рассчитывается как время на сервере минус разница часовых поясов пользователя и сервера</em></p></td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
</request>
```

{% endtab %}
{% endtabs %}


# Пополнение баланса пользователям

Спецификации для пополнения баланса пользователям: XML

{% tabs %}
{% tab title="XML" %}
Метод отправки **`POST`**

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

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="193">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.client</mark></p><p>[<mark style="color:green;">login_client</mark>]*</p></td><td>String</td><td>Логин клиента</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.client</mark></p><p><mark style="color:green;">[balance]</mark>*</p></td><td>Int</td><td>Сумма зачисления</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.client</mark></p><p><mark style="color:green;">[type_transaction]</mark>*</p></td><td>String</td><td><p>Тип транзакции:</p><p>- webmoney - WebMoney </p><p>- manager - Менеджер</p><p>- roboxchange – ROBOXchange</p><p>- cashless – Безналичный</p><p>- cashless_no_score – Безналичный без счета</p><p>- Qiwi – Qiwi</p><p>- yandexmoney - Яндекс.Деньги</p><p>- BITCOIN - Bitcoin</p><p>- trust_payment - Доверительный платеж</p><p>- write_off - Списание</p><p>- subscription - Абонентская плата</p></td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
    <transaction login="test_6_1" id_transaction="366"/>
    <transaction login="test_smpp_3" id_transaction="NO_USER"/>
    ...
    <transaction login="test_smpp_8" id_transaction="401"/>
</response>
```

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.transaction</mark></p><p><mark style="color:green;">[login]</mark></p></td><td>String</td><td>Логин клиента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.transaction</mark></p><p><mark style="color:green;">[id_transaction]</mark></p></td><td>Int</td><td><p>Id транзакции при зачисление средств
</p><p><em><strong><code>NO_USER</code></strong> – означает, что данный пользователь не найден</em></p></td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
     <security>
          <login value="логин" />
          <password value="пароль" />
     </security>
     <client login_client="test_6_1" balance="100" type_transaction="webmoney">
     <client login_client="test_smpp_3" balance="150" type_transaction="manager">
     ...
     <client login_client="test_smpp_8" balance="200" type_transaction="BITCOIN">
</request>
```

{% endtab %}
{% endtabs %}


# Загрузка файлов

Для загрузки файла на сервер необходимо отправить POST данные содержащие переменные **`login`**, **`password`**, **`file`**.&#x20;

В ответ будет выдан **`id`** сохраненного файла, который в дальнейшем вы можете использовать в своих запросах.&#x20;

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

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

### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

<table><thead><tr><th width="227">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>login*</td><td>String</td><td>Ваш логин в системе</td></tr><tr><td>password*</td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td>token*</td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td>file*</td><td>Data</td><td>Отправляемый файл</td></tr></tbody></table>

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

{% tabs %}
{% tab title="PHP" %}

```php
$href = "https://my3.webcom.mobi/xml/file.php"; 
// (Пример: $tmpfname = "C:\Program Files\file\test.jpg";)
$tmpfname = "имя";
$requist['login'] = "логин";
$requist['passsword'] = "пароль";
$requist['file'] = PHP_VERSION_ID <  56000 
    ? '@' . $tmpfname 
    : new CurlFile($tmpfname, 'image/jpg');
$ch = curl_init();
curl_setopt($ch, CURLOPT_URL, $href);
curl_setopt($ch, CURLOPT_POST, TRUE);
curl_setopt($ch, CURLOPT_HEADER, FALSE);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, TRUE);
curl_setopt($ch, CURLOPT_SSL_VERIFYPEER, FALSE);
curl_setopt($ch, CURLOPT_SSL_VERIFYHOST, FALSE);
curl_setopt($ch, CURLOPT_CONNECTTIMEOUT, 30);
curl_setopt($ch, CURLOPT_POSTFIELDS, $requist);
$result = curl_exec($ch);
curl_close($ch);
 
echo $result;
```

{% endtab %}
{% endtabs %}


# Руководство по взаимодействию с сервисом

**SMPP** — протокол, описывающий взаимодействие Клиента с SMS-сервером.

Взаимодействие Клиента с SMS-сервером Платформы осуществляется по адресу **`имя_хоста`** порт **`2775`**

### Настройка SMPP-клиента

Для работы с Платформой по протоколу SMPP, необходимо произвести следующие настройки SMPP-клиента:

*Host:* имя\_хоста

*Port:* 2775&#x20;

| Mode of Сonnections      | Transceiver |
| ------------------------ | ----------- |
| SMPP System ID:          | login\*     |
| SMPP Password:           | password\*  |
| SMPP System type:        | NULL        |
| SMPP Version:            | 3.4         |
| SMS per second:          | 30          |
| Enquire\_link:           | 60 sec.     |
| Transaction timeout:     | 30 sec.     |
| Source Address TON:      | 0           |
| Source Address NPI:      | 0           |
| Destination Address TON: | 1           |
| Destination Address NPI: | 1           |

\* Ваш логин и пароль, полученный при регистрации в сервисе.

{% hint style="info" %}
При подключении необходимо обратить внимание на частоту отправки пакета **ENQUIRE\_LINK**.&#x20;

Для исключения избыточной нагрузки и защиты от ошибок в ПО клиентов наша система ограничивает отправку данного пакета не чаще, чем раз в 10 секунд, но рекомендуется ставить 30-60 секунд.
{% endhint %}

#### Поддерживаются следующие кодировки:

* 7-битная GSM для латинского текста с поддержкой европейских символов − (coding = 0);
* 8-битная ISO-8859-1 (Latin-1) для латинского текста или бинарных данных − (coding = 1);
* UCS2 (UTF-16) для национальных алфавитов (например, русского) − (coding = 2).

#### SMPP использует три режима соединения:

* **bind\_transmitter** - Режим клиент -> сервер. Позволит вам отправлять команды на сервер, но не получать команды от него.
* **bind\_receiver** - Режим клиент <- сервер. Такой режим *не* позволит вам отправлять команды на отправку сообщений и запросы статусов.
* **bind\_transceiver** - Режим клиент <-> сервер. Универсальный режим соединения - позволит и передавать и принимать команды.

Используйте **`bind_transceiver`**, если вам необходимо получать от сервера статусы сообщений в режиме реального времени. Если же вы собираетесь отправлять сообщения и запрашивать статусы самостоятельно - вам может хватить и **`bind_transmitter`** режима.

В случае неудачной авторизации, **`command_status`** ответа будет равен **ESME\_RBINDFAIL**. В случае успеха - **ESME\_ROK**.

После успешной авторизации вы можете начинать отправлять команды серверу. Если вы использовали **`bind_transceiver`**, то сервер попытается отправить вам статусы сообщений, которые не успел или не смог отправить ранее по каким-либо причинам.


# Спецификация

### Краткий обзор SMPP

Протокол Одноранговых Коротких Сообщений (SMPP) – это открытый протоколо траслевого стандарта, предназначенный для осуществления гибкого интерфейса передачи данных для перемещения данных короткого сообщения между Центром Сообщений (Message Center), таким как :

* Центр Службы Коротких Сообщений (Short Message Service Centre) (SMSC)
* Сервер (USSD)Данных Неструктурированных Дополнительных Служб GSM (GSM Unstructured SupplementaryServices Data (USSD) Server)
* другие типы Message Center и системой приложений SMS, типа WAP Proxy Server, EMail Gateway или другого Messaging Gateway.

{% hint style="info" %}
Ради краткости, в этом документе для описания любого элемента «сервер» («server») SMPP, к которому может быть подключен «клиент» («client») SMPP, называемый Элемент Внешней Системы Короткого Сообщения(External Short Message Entity) (ESME), повсюду будет использоваться термин SMSC
{% endhint %}

Выпуск v 3.4 SMPP поддерживает технологии Digital Cellular Network, включая:&#x20;

* GSM
* IS-95 (CDMA)
* ANSI-136 (TDMA) • iDEN

Используя протокол SMPP, система приложений SMS, называемая «Элемент Внешней Системы Короткого Сообщения» («External Short Message Entity») (ESME), может инициировать соединение на уровне приложения с SMSC через сетевое соединение TCP/IP или X. 25 и может затем отправлять короткие сообщения и получать короткие сообщения на и из SMSC соответственно. ESME может также запрашивать, отменять или заменять короткие сообщения, используя SMPP.

SMPP поддерживает полнофункциональный набор функций приема-передачи сообщений, таких как:

* Передача сообщений из ESME одиночным или множественным номерам абонентов через SMSC
* ESME может получать сообщения через SMSC из других SME (например, мобильных станций)
* Запрос статуса короткого сообщения, сохраняемого на SMSC
* Отмена или замена короткого сообщения, сохраняемого на SMSC
* Отправка зарегистрированного короткого сообщения (для которого SMSC вернет «расписку о получении» («delivery receipt») создателю сообщения)
* Назначение даты и времени доставки сообщения
* Выбор режима сообщения, то есть, дейтаграммного или хранения и отправки
* Установка приоритета доставки короткого сообщения
* Определение типа кодировки данных короткого сообщения
* Установка периода достоверности короткого сообщения
* Ассоциирование типа службы с каждым сообщением, например, уведомлениемголосовой почты

Этот документ определяет Версию 3.4 протокола SMPP и детально излагает формат команды и ответа, который должен использоваться приреализации интерфейса протокола v3.4 SMPP.

Он предназначается для разработчиков и реализаторов проектного замысла интерфейса v3.4 SMPP между SMSC и External Short Message Entity (ESME), как проиллюстрировано в следующей диаграмме.

<figure><img src="blob:https://app.gitbook.com/75a9e23c-7837-4061-80f3-7f93cc56310a" alt=""><figcaption></figcaption></figure>

#### Более подробнее вы можете ознакомиться в специализированном документе описывающем спецификацию протокола SMPP v.3.4

{% file src="/files/b2QJ17iqmK3b3kRYb84Y" %}
**Спецификация протокола SMPP v.3.4**
{% endfile %}


# Описание статусов ошибок

Отраслевые спецификации и стандарты

<table><thead><tr><th width="161">Номер ошибки в шестнадцатеричном формате</th><th width="100">Номер ошибки в десятичном формате</th><th>Имя ошибки</th><th>Описание ошибки</th></tr></thead><tbody><tr><td>0x00000000 </td><td>0</td><td>ESME_ROK </td><td>Нет ошибки</td></tr><tr><td>0x00000001 </td><td>1</td><td>ESME_RINVMSGLEN </td><td>Слишком длинное сообщение</td></tr><tr><td>0x00000002 </td><td>2</td><td>ESME_RINVCMDLEN </td><td>Длина команды недопустима</td></tr><tr><td>0x00000003 </td><td>3</td><td>ESME_RINVCMDID </td><td>Идентификатор команды недействителен или не поддерживается</td></tr><tr><td>0x00000004 </td><td>4</td><td>ESME_RINVBNDSTS </td><td>Неверный статус связывания для данной команды</td></tr><tr><td>0x00000005 </td><td>5</td><td>ESME_RALYBND </td><td>Уже связаны</td></tr><tr><td>0x00000006 </td><td>6</td><td>ESME_RINVPRTFLG </td><td>Флаг недопустимого приоритета</td></tr><tr><td>0x00000007 </td><td>7</td><td>ESME_RINVREGDLVFLG </td><td>Неверный флаг заказной доставки</td></tr><tr><td>0x00000008 </td><td>8</td><td>ESME_RSYSERR </td><td>Системная ошибка</td></tr><tr><td>0x00000009 </td><td>9</td><td>Зарезервировано </td><td> </td></tr><tr><td>0x0000000A </td><td>10</td><td>ESME_RINVSRCADR </td><td>Недопустимый адрес источника</td></tr><tr><td>0x0000000B </td><td>11</td><td>ESME_RINVDSTADR </td><td>Недопустимый адрес назначения</td></tr><tr><td>0x0000000C </td><td>12</td><td>ESME_RINVMSGID </td><td>Идентификатор сообщения недействителен</td></tr><tr><td>0x0000000D </td><td>13</td><td>ESME_RBINDFAIL </td><td>Не удалось выполнить привязку</td></tr><tr><td>0x0000000E </td><td>14</td><td>ESME_RINVPASWD </td><td>Неверный пароль</td></tr><tr><td>0x0000000F </td><td>15</td><td>ESME_RINVSYSID </td><td>Неверный системный идентификатор</td></tr><tr><td>0x00000010 </td><td>16</td><td>Зарезервировано </td><td> </td></tr><tr><td>0x00000011 </td><td>17</td><td>ESME_RCANCELFAIL </td><td>Отмена сообщения не удалась</td></tr><tr><td>0x00000012 </td><td>18</td><td>Зарезервировано </td><td> </td></tr><tr><td>0x00000013 </td><td>19</td><td>ESME_RREPLACEFAIL </td><td>Замена сообщения не удалась</td></tr><tr><td>0x00000014 </td><td>20</td><td>ESME_RMSSQFUL </td><td>Очередь сообщений заполнена</td></tr><tr><td>0x00000015 </td><td>21</td><td>ESME_RINVSERTYP </td><td>Недопустимый тип сервиса</td></tr><tr><td>0x00000033 </td><td>51</td><td>ESME_RINVNUMDESTS </td><td>Недопустимое количество пунктов назначения</td></tr><tr><td>0x00000034 </td><td>52</td><td>ESME_RINVDLNAME </td><td>Недопустимое имя списка рассылки</td></tr><tr><td>0x00000040 </td><td>64</td><td>ESME_RINVDESTFLAG </td><td>Недопустимый флаг назначения</td></tr><tr><td>0x00000041 </td><td>65</td><td>Зарезервировано </td><td> </td></tr><tr><td>0x00000042 </td><td>66</td><td>ESME_RINVSUBREP </td><td>Некорректный запрос "Отправить с заменой</td></tr><tr><td>0x00000043 </td><td>67</td><td>ESME_RINVESMCLASS </td><td>Неверный набор классов esm</td></tr><tr><td>0x00000044 </td><td>68</td><td>ESME_RCNTSUBDL </td><td>Неверная отправка в список рассылки</td></tr><tr><td>0x00000045 </td><td>69</td><td>ESME_RSUBMITFAIL </td><td>Отправка сообщения не удалась</td></tr><tr><td>0x00000046 </td><td>70</td><td>Зарезервировано</td><td> </td></tr><tr><td>0x00000047 </td><td>71</td><td>Зарезервировано</td><td> </td></tr><tr><td>0x00000048 </td><td>72</td><td>ESME_RINVSRCTON </td><td>Недопустимый тип номера (TON) адреса источника</td></tr><tr><td>0x00000049 </td><td>73</td><td>ESME_RINVSRCNPI </td><td>Неверный план нумерации адресов источника (NPI)</td></tr><tr><td>0x00000050 </td><td>80</td><td>ESME_RINVDSTTON </td><td>Недопустимый тип номера адреса назначения (TON)</td></tr><tr><td>0x00000051 </td><td>81</td><td>ESME_RINVDSTNPI </td><td>Неверный план нумерации адресов назначения (NPI)</td></tr><tr><td>0x00000052 </td><td>82</td><td>Зарезервировано</td><td> </td></tr><tr><td>0x00000053 </td><td>83</td><td>ESME_RINVSYSTYP </td><td>Недопустимый тип системы</td></tr><tr><td>0x00000054 </td><td>84</td><td>ESME_RINVREPFLAG </td><td>Неверный флаг replace_if_present</td></tr><tr><td>0x00000055 </td><td>85</td><td>ESME_RINVNUMMSGS </td><td>Недопустимое количество сообщений</td></tr><tr><td>0x00000056 </td><td>86</td><td>Зарезервировано</td><td> </td></tr><tr><td>0x00000057 </td><td>87</td><td>Зарезервировано </td><td> </td></tr><tr><td>0x00000058 </td><td>88</td><td>ESME_RTHROTTLED </td><td>Ошибка дросселирования</td></tr><tr><td>0x00000059 </td><td>89</td><td>Зарезервировано </td><td> </td></tr><tr><td>0x00000060 </td><td>96</td><td>Зарезервировано </td><td> </td></tr><tr><td>0x00000061 </td><td>97</td><td>ESME_RINVSCHED </td><td>Неверное запланированное время поставки</td></tr><tr><td>0x00000062 </td><td>98</td><td>ESME_RINVEXPIRY </td><td>Неверное значение срока действия</td></tr><tr><td>0x00000063 </td><td>99</td><td>ESME_RINVDFTMSGID </td><td>Не найдено предопределенное сообщение</td></tr><tr><td>0x00000064 </td><td>100</td><td>ESME_RX_T_APPN </td><td>Временная ошибка приемника ESME</td></tr><tr><td>0x00000065 </td><td>101</td><td>ESME_RX_P_APPN </td><td>Постоянная ошибка приемника ESME</td></tr><tr><td>0x00000066 </td><td>102</td><td>ESME_RX_R_APPN </td><td>Ошибка отклонения сообщения приемника ESME</td></tr><tr><td>0x00000067 </td><td>103</td><td>ESME_RQUERYFAIL </td><td>Запрос запроса сообщения не удался</td></tr><tr><td>0x00000068-<br>0x000000BF</td><td>104-191 </td><td>Зарезервировано </td><td> </td></tr><tr><td>0x000000C0 </td><td>192</td><td>ESME_RINVTLVSTREAM </td><td>Ошибка в необязательной части тела PDU</td></tr><tr><td>0x000000C1 </td><td>193</td><td>ESME_RTLVNOTALLWD </td><td>TLV не разрешен</td></tr><tr><td>0x000000C2 </td><td>194</td><td>ESME_RINVTLVLEN </td><td>Недопустимая длина параметра</td></tr><tr><td>0x000000C3 </td><td>195</td><td>ESME_RMISSINGTLV </td><td>Ожидаемый TLV отсутствует</td></tr><tr><td>0x000000C4 </td><td>196</td><td>ESME_RINVTLVVAL </td><td>Недопустимое значение TLV</td></tr><tr><td>0x000000C5-<br>0x000000FD</td><td>197-253 </td><td>Зарезервировано </td><td> </td></tr><tr><td>0x000000FE </td><td>254</td><td>ESME_RDELIVERYFAILURE </td><td>Сбой доставки транзакции</td></tr><tr><td>0x000000FF </td><td>255</td><td>ESME_RUNKNOWNERR </td><td>Неизвестная ошибка</td></tr><tr><td>0x00000100 </td><td>256</td><td>ESME_RSERTYPUNAUTH </td><td>ESME не имеет права использовать указанный тип сервиса</td></tr><tr><td>0x00000101 </td><td>257</td><td>ESME_RPROHIBITED </td><td>ESME запрещено использовать указанную операцию</td></tr><tr><td>0x00000102 </td><td>258</td><td>ESME_RSERTYPUNAVAIL </td><td>Указанный тип сервиса недоступен</td></tr><tr><td>0x00000103 </td><td>259</td><td>ESME_RSERTYPDENIED </td><td>Указанный тип сервиса запрещен</td></tr><tr><td>0x00000104 </td><td>260</td><td>ESME_RINVDCS </td><td>Неверная схема кодирования данных</td></tr><tr><td>0x00000105 </td><td>261</td><td>ESME_RINVSRCADDRSUBUNIT </td><td>Недопустимый адрес источника субъединицы</td></tr><tr><td>0x00000106 </td><td>262</td><td>ESME_RINVSTDADDRSUBUNIR </td><td>Неверный субъединица адреса назначения</td></tr><tr><td>0x00000400- </td><td>1024 — </td><td> </td><td>Коды ошибок, характерные для оператора</td></tr></tbody></table>