# Запрос проверки баланса

## Запрос проверки баланса

<mark style="color:green;">`POST`</mark> `http://lk.mysmpp.ru/xml/balance.php`

#### Headers

| Name                                           | Type   | Description                    |
| ---------------------------------------------- | ------ | ------------------------------ |
| Content-type<mark style="color:red;">\*</mark> | String | **`text/xml; charset=utf-8;`** |

#### Request Body

| Name                                             | Type   | Description                                                                                        |
| ------------------------------------------------ | ------ | -------------------------------------------------------------------------------------------------- |
| login.value<mark style="color:red;">\*</mark>    | String | Ваш логин в системе                                                                                |
| password.value<mark style="color:red;">\*</mark> | String | Ваш пароль в системе                                                                               |
| token.value<mark style="color:red;">\*</mark>    | String | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру |

{% tabs %}
{% tab title="200: OK В случае получения правильного XML-документа" %}

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <money>150</money>
     <sms area="Россия">111</sms>
     <sms area="Украина">111</sms>
</response>
```

{% endtab %}

{% tab title="400: Bad Request В случае возникновения ошибки в отправленном XML-документе" %}

```xml
<?xml version="1.0" encoding="utf-8"?>
<response>
     <error>текст ошибки</error>
</response>
```

{% endtab %}
{% endtabs %}

### Расшифровка параметров в ответах на запрос

<table><thead><tr><th width="136.33333333333331">Параметр</th><th width="145">Тип данных</th><th>Описание</th></tr></thead><tbody><tr><td>money</td><td>Int</td><td>Остаток средств</td></tr><tr><td>sms</td><td>Int</td><td>Количество доступных SMS сообщений для данного направления</td></tr><tr><td>sms.area</td><td>String</td><td>Направление, в котором может быть отправлено данное количество SMS</td></tr><tr><td>error</td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

```xml
<?xml  version="1.0" encoding="utf-8" ?>
<request>
   <security>
      <login value="логин" />
      <password value="пароль" />
   </security>
</request>
```

{% hint style="info" %}
При этом количество SMS не может быть суммировано по разным направлениям. При отправке смс в одном направлении уменьшается количество доступных SMS сообщений во всех других направления в соответствии с их стоимостью.
{% endhint %}

### Пример

У вас на балансе 10 y.e.\
Стоимость SMS сообщения отправленного в Россию составляет 1 y.e.\
Стоимость SMS сообщения отправленного в Украину составляет 2 y.e.

При этом вам вернется XML-документ следующего содержания:

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <money>10</money>
     <sms area="Россия">10</sms>
     <sms area="Украина">5</sms>
</response>
```

Если вы отправите две смс в Россию, то XML-документ изменится следующим образом:

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <money>8</money>
     <sms area="Россия">8</sms>
     <sms area="Украина">4</sms>
</response>
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://apidocs.webcom.mobi/ru2/type/specifikaciya-xml/zapros-proverki-balansa.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.