> 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/izmenenie-parametrov-dobavlenie-udalenie-baz.md).

# Изменение параметров, добавление/удаление баз

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/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 | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру                                                                                        |
| <p>request</p><p><mark style="color:orange;">.bases</mark></p><p><mark style="color:purple;">.base\*</mark></p>                                                             | String | Текст поздравления                                                                                                                                                                        |
| <p>request</p><p><mark style="color:orange;">.bases</mark></p><p><mark style="color:purple;">.base</mark></p><p><mark style="color:green;">\[id\_base]</mark></p>           | Int    | <p>Уникальный номер базы в системе.</p><p>Если не указан произойдет добавление базы. <mark style="color:orange;">При этом нужно указать параметр <strong>number\_base</strong></mark></p> |
| <p>request</p><p><mark style="color:orange;">.bases</mark></p><p><mark style="color:purple;">.base</mark></p><p><mark style="color:green;">\[number\_base]</mark></p>       | Int    | Номер базы в XMLзапросе. Указывается только при создании новой базы. Используется для сопоставления ID добавленных баз (если их было несколько в запросе)                                 |
| <p>request</p><p><mark style="color:orange;">.bases</mark></p><p><mark style="color:purple;">.base</mark></p><p><mark style="color:green;">\[name\_base]</mark></p>         | Int    | Название базы                                                                                                                                                                             |
| <p>request</p><p><mark style="color:orange;">.bases</mark></p><p><mark style="color:purple;">.base</mark></p><p><mark style="color:green;">\[time\_birth]</mark></p>        | Time   | Время поздравления                                                                                                                                                                        |
| <p>request</p><p><mark style="color:orange;">.bases</mark></p><p><mark style="color:purple;">.base</mark></p><p><mark style="color:green;">\[local\_time\_birth]</mark></p> | String | Считать время поздравления относительно местного времени абонента (**`yes`**) или относительно времени системы (**`no`**)                                                                 |
| <p>request</p><p><mark style="color:orange;">.bases</mark></p><p><mark style="color:purple;">.base</mark></p><p><mark style="color:green;">\[originator\_birth]</mark></p>  | String | Отправитель поздравления                                                                                                                                                                  |
| <p>request</p><p><mark style="color:orange;">.bases</mark></p><p><mark style="color:purple;">.base</mark></p><p><mark style="color:green;">\[on\_birth]</mark></p>          | Int    | <p>Включены ли поздравления:</p><ul><li>yes – включены</li><li>no - выключены</li></ul>                                                                                                   |
| <p>request</p><p><mark style="color:orange;">.delete\_bases</mark></p><p><mark style="color:purple;">.base</mark></p><p><mark style="color:green;">\[id\_base]</mark></p>   | Int    | Уникальный номер базы в системе, который необходимо удалить                                                                                                                               |

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <base id_base=”1234”>edit</base>
     <base number_base=”1” id_base=”1235”>insert</base>
     <base number_base=”2” id_base=”1236”>edit</base>
     <base id_base=”1235”>delete</base>
     <base id_base=”1235”>not_found</base>
…
</response>
```

| Параметр                                                                                                                | Тип   | Описание                                                                                                                                                    |
| ----------------------------------------------------------------------------------------------------------------------- | ----- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>response</p><p><mark style="color:orange;">.base</mark></p>                                                          | Sting | Действие                                                                                                                                                    |
| <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;">\[number\_base]</mark></p> | Int   | Номер базы в XML запросе. Указывается только при создании новой базы. Используется для сопоставления ID добавленных баз (если их было не сколько в запросе) |

## В случае возникновения ошибки в отправленном 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>
     <bases>
          <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 number_base="1" name_base="База Московского офиса" time_birth="12:48" local_time_birth="yes" day_before="1" originator_birth="fitnes" on_birth="yes">Поздравляем!</base>
     </bases>
     <delete_bases>
          <base id_base="1235" />
          <base id_base="1236" />
          …
     </delete_bases>
</request>
```

{% endtab %}
{% endtabs %}