> 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-spiska-baz.md).

# Получение списка баз

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/list_bases.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 | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру |

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <base id_base="1234" name_base="База главного офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
     <base id_base="1235" name_base="База Московского офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
     …
</response>
```

| Параметр                                                                                                                      | Тип    | Описание                                                                                                                 |
| ----------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------ |
| <p>response</p><p><mark style="color:orange;">.base</mark></p>                                                                | String | Текст поздравления                                                                                                       |
| <p>response</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">\[id\_base]</mark></p>           | Int    | Уникальный номер базы в системе                                                                                          |
| <p>response</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">\[name\_base]</mark></p>         | String | Название базы                                                                                                            |
| <p>response</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">\[time\_birth]</mark></p>        | Time   | Время поздравления                                                                                                       |
| <p>response</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">\[local\_time\_birth]</mark></p> | String | Считать время поздравления относительно местного времени абонента(**`yes`**) или относительно времени системы (**`no`**) |
| <p>response</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">\[day\_before]</mark></p>        | Int    | За сколько дней до дня рождения поздравлять                                                                              |
| <p>response</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">\[originator\_birth]</mark></p>  | String | Отправитель поздравления                                                                                                 |
| <p>response</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">\[on\_birth]</mark></p>          | String | <p></p><p>Включены ли поздравления:</p><ul><li>yes – включены</li><li>no - выключены</li></ul>                           |

## В случае возникновения ошибки в отправленном 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><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>
</request>
```

{% endtab %}
{% endtabs %}