# Запрос на получение списка запланированных SMS

## Запрос на получение списка запланированных SMS

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

#### Headers

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

#### Request Body

| Name                                             | Type   | Description                                                                                                                                                                    |
| ------------------------------------------------ | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| login.value<mark style="color:red;">\*</mark>    | String | Ваш логин в системе                                                                                                                                                            |
| scheduled.page<mark style="color:red;">\*</mark> | Int    | Номер страницы. Весь список запланированных SMS делится на страницы. Запросить список целиком нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички |
| token.value<mark style="color:red;">\*</mark>    | String | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру                                                                             |
| password.value<mark style="color:red;">\*</mark> | String | Ваш пароль в системе                                                                                                                                                           |

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

{% 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="164.33333333333331">Параметр</th><th width="164">Тип данных</th><th>Описание</th></tr></thead><tbody><tr><td>phones.page</td><td>Int</td><td>Номер страницы</td></tr><tr><td>phones.num_pages</td><td>Int</td><td>Всего страниц</td></tr><tr><td>phones.scheduled.id_sms</td><td>Int</td><td>Номер SMS. Используется для удаления запланированной SMS</td></tr><tr><td>phones.scheduled.time_put_turn</td><td>Int</td><td>Время добавления в планировщик</td></tr><tr><td>phones.scheduled.originator</td><td>String</td><td>Отправитель SMS. Именно это значение будет выводиться на телефоне абонента в поле от кого SMS</td></tr><tr><td>phones.scheduled.phone</td><td>Int</td><td>Номер абонента, которому адресована SMS</td></tr><tr><td>phones.scheduled.type</td><td>String</td><td><p>Тип SMS сообщения:</p><ul><li>sms – обычная SMS</li><li>flashsms – Flash SMS</li><li>wappush – WAP-Push</li><li>vcard – визитная карточка (vCard)</li></ul></td></tr><tr><td>phones.scheduled.text_sms</td><td>String</td><td>Текст SMS-сообщения</td></tr><tr><td>phones.scheduled.count_sms</td><td>Int</td><td>Количество частей SMS-сообщения</td></tr><tr><td>phones.scheduled.name_delivery</td><td>String</td><td>Название рассылки</td></tr><tr><td>phones.scheduled.time_send</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>phones.scheduled.validity_period</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><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>
     <scheduled page=”1”/>
</request>
```