# Запрос входящих SMS

## Запрос входящих SMS

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

#### Headers

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

#### Request Body

| Name                                             | Type   | Description                                                                                                                                                                           |
| ------------------------------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| login.value<mark style="color:red;">\*</mark>    | String | Ваш логин в системе                                                                                                                                                                   |
| token.value<mark style="color:red;">\*</mark>    | String | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру                                                                                    |
| password.value<mark style="color:red;">\*</mark> | String | Ваш пароль в системе                                                                                                                                                                  |
| time.start<mark style="color:red;">\*</mark>     | String | Время (не включительно), с которого запрашиваются входящие SMS                                                                                                                        |
| time.end                                         | String | <p>Время (не включительно), по которое запрашиваются входящие SMS. Не обязательный параметр. </p><p><mark style="color:orange;">Если не задан, то будут возвращены все смс</mark></p> |

{% tabs %}
{% tab title="200: OK В случае получения правильного 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>
```

{% endtab %}

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

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

{% endtab %}
{% endtabs %}

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

<table><thead><tr><th width="173.33333333333331">Параметр</th><th width="141">Тип данных</th><th>Описание</th></tr></thead><tbody><tr><td>sms.id_sms</td><td>Int</td><td>Уникальный номер, состоящий только из цифр</td></tr><tr><td>sms.date_receive</td><td>Int</td><td>Дата и время получения SMS</td></tr><tr><td>sms.originator</td><td>Int</td><td>Номер телефона абонента, отправившего SMS</td></tr><tr><td>sms.prefix</td><td>String</td><td>Префикс. Начальная часть текста SMS, по которой было определено, что эта SMS принадлежит именно этому клиенту. (Используется если один и тот же номер используется разными клиентами.)</td></tr><tr><td>sms.phone</td><td>Int</td><td>Номер телефона, на который была отправлена SMS</td></tr><tr><td>error</td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

### Пример 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>
```