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

Спецификации для получение списка запланированных сообщений: 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 %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.webcom.mobi/ru/poluchenie-spiska-zaplanirovannykh-soobshenii.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.