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

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

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/list_scheduled.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;">.scheduled</mark></p><p><mark style="color:purple;">.[page]</mark></p>                                                   | Int    | <p>Номер страницы.</p><p><em>Весь список запланированных сообщений делится на страницы. Запросить список целиком нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с едини</em>чки</p> |

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

## В случае получения правильного 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="259">Параметр</th><th width="174">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">[page]</mark></p></td><td>Int</td><td>Номер страницы</td></tr><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">[num_pages]</mark></p></td><td>Int</td><td>Всего страниц</td></tr><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[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:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[time_put_turn]</mark></p></td><td>Date</td><td>Время добавления в планировщик</td></tr><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[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:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[phone]</mark></p></td><td>Int</td><td>Номер абонента, которому адресовано сообщение</td></tr><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[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:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[text_sms]</mark></p></td><td>String</td><td>Текст сообщения</td></tr><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[count_sms]</mark></p></td><td>Int</td><td>Количество частей сообщения</td></tr><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[name_delivery]</mark></p></td><td>String</td><td>Название рассылки</td></tr><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[time_send]</mark></p></td><td>Date</td><td><p>Дата и время отправки в формате:</p><p>YYYY-MM-DD HH:MM</p><p>где, </p><p>YYYY-год, </p><p>MM-месяц, </p><p>DD-день, </p><p>HH-часы,</p><p>MM-минуты</p></td></tr><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.scheduled</mark></p><p><mark style="color:green;">[validity_period]</mark></p></td><td>Date</td><td><p>Дата и время, после которых не будут делаться попытки доставить SMS в формате:</p><p>YYYY-MM-DD HH:MM:SS</p><p>где, </p><p>YYYY-год, MM-месяц, DD-день, </p><p>HH-часы,</p><p>MM-минуты</p><p>SS-секунды</p></td></tr></tbody></table>

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

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

| Параметр                                                        | Тип    | Описание                                                                                                                                                                                                          |
| --------------------------------------------------------------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>response</p><p><mark style="color:orange;">.error</mark></p> | String | <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>
     <scheduled page=”1”/>
</request>
```
{% endtab %}
{% endtabs %}
