> 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-abonentov-bazy.md).

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

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

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

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

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

#### Параметры запроса на отправку сообщения <a href="#parametry-zaprosa-na-otpravku-soobsheniya-2" id="parametry-zaprosa-na-otpravku-soobsheniya-2"></a>

| Параметр                                                                                                                                                                | Тип    | Описание                                                                                                                                                                           |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <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;">.base</mark></p><p><mark style="color:purple;">\[id\_base]\*</mark></p>                                                    | Int    | Номер базы в системе                                                                                                                                                               |
| <p>request</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">\[page]\*</mark></p>                                                        | Int    | <p>Номер страницы.</p><p>Весь список номеров базы делится на страницы. Запросить целиком базу нельзя. Можно лишь запросить отдельную страницу. Нумерация начинается с единички</p> |
| <p>request</p><p><mark style="color:orange;">.base</mark></p><p><mark style="color:purple;">\[last\_update]</mark></p>                                                  | Date   | Минимальная дата и время регистрации (или последнего изменения) данных абонента, которых Вам нужно запросить                                                                       |

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <phones page="1" num_pages="100">
          <phone phone="79612242243" region="Новосибирск" operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" male="m" addition_1="Первое дополнительное поле" addition_2="второе" last_update=” 2011-03-25 08:39:48” />
          <phone phone="79612242244" region="Новосибирск" operator="Вымпелком" name="Константин" surname="Ермолаев" patronymic="Александрович" date_birth="1984-08-21" male="m" addition_1="Первое дополнительное поле" addition_2="второе" last_update=” 2011-03-25 08:39:48” />
          …
     </phones>
</response>
```

| Параметр                                                                                                                                                                 | Тип    | Описание                                                            |
| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------ | ------------------------------------------------------------------- |
| <p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">\[page]</mark></p>                                                        | Int    | Номер страницы                                                      |
| <p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">\[num\_pages]</mark></p>                                                  | Int    | Всего страниц                                                       |
| <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>        | Int    | Номер телефона абонента                                             |
| <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>       | String | Регион                                                              |
| <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>     | String | Оператор                                                            |
| <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>         | String | Имя абонента                                                        |
| <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>      | String | Фамилия абонента                                                    |
| <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>   | String | Отчество абонента                                                   |
| <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>  | Date   | Дата рождения                                                       |
| <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>         | String | <p>Пол:</p><ul><li>«f»- женский</li><li>«m» - мужской</li></ul>     |
| <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>  | String | Первое дополнительное поле                                          |
| <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>  | String | Второе дополнительное поле                                          |
| <p>response</p><p><mark style="color:orange;">.phones</mark></p><p><mark style="color:purple;">.phone</mark></p><p><mark style="color:green;">\[last\_update]</mark></p> | Date   | Дата и время регистрации (или последнего изменения) данных абонента |

## В случае возникновения ошибки в отправленном 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" page=”1” last_update=”2011-03-25 08:39:48”/>
</request>
```

{% endtab %}
{% endtabs %}