# Добавление/удаление абонентов в СТОП-лист

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/stop.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;">.add\_stop</mark></p><p><mark style="color:purple;">.phone</mark></p><p><mark style="color:green;">\[phone]</mark></p>     | Int    | Номер телефона абонента, которого нужно добавить в СТОП-лист                                       |
| <p>request</p><p><mark style="color:orange;">.delete\_stop</mark></p><p><mark style="color:purple;">.phone</mark></p><p><mark style="color:green;">\[phone]</mark></p>  | Int    | Номер телефона абонента, которого нужно удалить из СТОП-листа                                      |

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
    <phone phone="79612242243">delete</phone>
    <phone phone="79612242244">add</phone>
    <phone phone="79612242245">not_found</phone>
    …
</response>
```

| Параметр                                                                                                          | Тип    | Описание             |
| ----------------------------------------------------------------------------------------------------------------- | ------ | -------------------- |
| <p>response</p><p><mark style="color:orange;">.phone</mark></p>                                                   | String | Выполненное действие |
| <p>response</p><p><mark style="color:orange;">.phone</mark></p><p><mark style="color:purple;">\[phone]</mark></p> | Int    | Номер телефона       |

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

{% endtab %}
{% endtabs %}