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

Спецификации для проверки баланса: JSON, XML

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

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

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

Адрес для запроса: **`https://my3.webcom.mobi/xml/balance.php`**

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

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.login</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш логин в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.password</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td><p>request</p><p><mark style="color:blue;">.security</mark></p><p><mark style="color:blue;">.token</mark></p><p><mark style="color:orange;">[value]</mark>*</p></td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr></tbody></table>

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

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

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

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.money</mark></p></td><td>Int</td><td>Остаток средств</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p></td><td>Int</td><td>Количество доступных SMS сообщений для данного направления</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.sms</mark></p><p><mark style="color:green;">[area]</mark></p></td><td>String</td><td>Направление, в котором может быть отправлено данное количество сообщений</td></tr></tbody></table>

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

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

<table><thead><tr><th width="197.66666666666666">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td><p>response</p><p><mark style="color:blue;">.error</mark></p></td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат XML документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

### &#x20;Пример 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://my3.webcom.mobi/json/balance.php`**

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

<table><thead><tr><th width="158">Параметр</th><th width="110.66666666666666">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>login*</td><td>String</td><td>Ваш логин в системе</td></tr><tr><td>password*</td><td>String</td><td>Ваш пароль в системе</td></tr><tr><td>token*</td><td>String</td><td>Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру</td></tr></tbody></table>

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

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

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

<table><thead><tr><th width="190.66666666666666">Параметр</th><th width="124">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>money</td><td>Int</td><td>Остаток средств</td></tr><tr><td>currency</td><td>String</td><td>Валюта</td></tr><tr><td><p>information</p><p>.type_sms</p></td><td>String</td><td>Тип сообщения</td></tr><tr><td><p>information</p><p>.area</p></td><td>String</td><td>Направление, в котором может быть отправлено данное количество сообщений</td></tr><tr><td><p>information</p><p>.num_sms</p></td><td>Int/String</td><td>Количество доступных сообщений для данного направления</td></tr></tbody></table>

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

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

<table><thead><tr><th width="289.66666666666663">Параметр</th><th width="121">Тип</th><th>Описание</th></tr></thead><tbody><tr><td>error</td><td>String</td><td><p>Текст ошибки может принимать следующие значения:</p><ul><li>Неправильный формат JSON документа </li><li>Ваш аккаунт заблокирован</li><li>Неправильный логин или пароль</li><li>POST данные отсутствуют</li></ul></td></tr></tbody></table>

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

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

{% endtab %}
{% endtabs %}