> For the complete documentation index, see [llms.txt](https://sms-club.gitbook.io/smsclub24ru/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://sms-club.gitbook.io/smsclub24ru/poluchenie-vkhodyashikh-soobshenii.md).

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

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/incoming.php`**

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

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

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

## В случае получения правильного 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>
```

| Параметр                                          | Тип    | Описание                                                                                                                                                                               |
| ------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>response</p><p>.sms</p>                        | String | Входящее сообщение                                                                                                                                                                     |
| <p>response</p><p>.sms</p><p>\[id\_sms]</p>       | Int    | Уникальный номер, состоящий только из цифр                                                                                                                                             |
| <p>response</p><p>.sms</p><p>\[date\_receive]</p> | Date   | Дата и время получения сообщения                                                                                                                                                       |
| <p>response</p><p>.sms</p><p>\[originator]</p>    | Int    | Номер телефона абонента, отправившего                                                                                                                                                  |
| <p>response</p><p>.sms</p><p>\[prefix]</p>        | String | Префикс. Начальная часть текста SMS, по которой было определено, что эта SMS принадлежит именно этому клиенту. (Используется если один и тот же номер используется разными клиентами.) |
| <p>response</p><p>.sms</p><p>\[phone]</p>         | Int    | Номер телефона, на который была отправлено сообщение                                                                                                                                   |

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

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

| Параметр                     | Тип    | Описание                                                                                                                                                                                                                 |
| ---------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| <p>response</p><p>.error</p> | String | <p></p><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа</li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul> |

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