> 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/proverka-balansa.md).

# Проверка баланса

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/balance.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>
     <money>150</money>
     <sms area="Россия">111</sms>
     <sms area="Украина">111</sms>
</response>
```

| Параметр                                                                                                       | Тип    | Описание                                                                 |
| -------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------ |
| <p>response</p><p><mark style="color:orange;">.money</mark></p>                                                | Int    | Остаток средств                                                          |
| <p>response</p><p><mark style="color:orange;">.sms</mark></p>                                                  | Int    | Количество доступных SMS сообщений для данного направления               |
| <p>response</p><p><mark style="color:orange;">.sms</mark></p><p><mark style="color:purple;">\[area]</mark></p> | String | Направление, в котором может быть отправлено данное количество сообщений |

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

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

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

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

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

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

| Параметр   | Тип    | Описание                                                                                           |
| ---------- | ------ | -------------------------------------------------------------------------------------------------- |
| login\*    | String | Ваш логин в системе                                                                                |
| password\* | String | Ваш пароль в системе                                                                               |
| token\*    | String | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру |

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

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

```json
{
    "money": "19023.9",
    "currency": "RUR",
    "information": 
        [
            {
                "type_sms": "sms",
                "area": "Tele2",
                "num_sms": "72029"
            }, 
            {
                "type_sms": "sms",
                "area": "Россия",
                "num_sms": "Безлимит"
            }
        ]
}
```

| Параметр                            | Тип        | Описание                                                                 |
| ----------------------------------- | ---------- | ------------------------------------------------------------------------ |
| money                               | Int        | Остаток средств                                                          |
| currency                            | String     | Валюта                                                                   |
| <p>information</p><p>.type\_sms</p> | String     | Тип сообщения                                                            |
| <p>information</p><p>.area</p>      | String     | Направление, в котором может быть отправлено данное количество сообщений |
| <p>information</p><p>.num\_sms</p>  | Int/String | Количество доступных сообщений для данного направления                   |

## В случае возникновения ошибки в отправленном JSON-документе

```json
{
    "error": "Текст ошибки."
}
```

| Параметр | Тип    | Описание                                                                                                                                                                                                                  |
| -------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| error    | String | <p></p><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат JSON документа</li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul> |

## Пример JSON запроса

```json
{
    "login": "логин",
    "password": "пароль",
}
```

{% endtab %}
{% endtabs %}