> 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/dobavlenie-redaktirovanie-udalenie-abonentov-bazy.md).

# Добавление/редактирование/удаление абонентов базы

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/phones.php`**

## Параметры запроса на отправку сообщения

<table><thead><tr><th width="228">Параметр</th><th>Тип</th><th>Описание</th></tr></thead><tbody><tr><td><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></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><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></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><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></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr><tr><td><p>request</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">[id_base]*</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;">.phone</mark></p><p><mark style="color:green;">[phone]*</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;">.phone</mark></p><p><mark style="color:green;">[region]</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;">.phone</mark></p><p><mark style="color:green;">[operator]</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;">.phone</mark></p><p><mark style="color:green;">[name]</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;">.phone</mark></p><p><mark style="color:green;">[surname]</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;">.phone</mark></p><p><mark style="color:green;">[patronymic]</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;">.phone</mark></p><p><mark style="color:green;">[date_birth]</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;">.phone</mark></p><p><mark style="color:green;">[male]</mark></p></td><td>String</td><td><p>Пол:</p><ul><li>«f»- женский</li><li>«m» - мужской</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.phone</mark></p><p><mark style="color:green;">[addition_1]</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;">.phone</mark></p><p><mark style="color:green;">[addition_2]</mark></p></td><td>String</td><td>Второе дополнительное поле</td></tr><tr><td><p>sponse</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.phone</mark></p><p><mark style="color:green;">[number_phone]</mark></p></td><td>Int</td><td>Порядковый номер телефона в системе</td></tr><tr><td><p>sponse</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.phone</mark></p><p><mark style="color:green;">[action]</mark></p></td><td>String</td><td>В случае необходимости удаления "delete"</td></tr></tbody></table>

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <base id_base="1234">
          <phone phone="79612242243" number_phone="1"/>insert</phone>
          <phone phone="79612242244" number_phone="2" />edit</phone>
          <phone phone="79612242243" number_phone="5"/>delete</phone>
          <phone phone="79612242244" number_phone="6" />not_found</phone>
     </base>
     …
</response>
```

<table><thead><tr><th width="266">Параметр</th><th width="161">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">[id_base]</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;">.phone</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;">.phone</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;">.phone</mark></p><p><mark style="color:green;">[number_phone]</mark></p></td><td>Int</td><td>Порядковый номер телефона в систем</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>
     <base id_base="1234">
          <phone phone="79612242243" region="Новосибирск" operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" male="мужской" addition_1="Первое дополнительное поле" addition_2="второе" number_phone="1"/>
          <phone phone="79612242244" region="Новосибирск" operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" male="мужской" addition_1="Первое дополнительное поле" addition_2="второе" number_phone="2" />
          …
          <phone phone="79612242243" action="delete" number_phone="5"/>
          <phone phone="79612242244" action="delete" number_phone="6"/>
     </base>
</request>
```

{% endtab %}
{% endtabs %}