> 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-statusa-soobsheniya/post-zapros.md).

# POST запрос

Спецификации для запроса статуса: JSON, XML, HTTP GET

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/state.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;">.get\_state</mark></p><p><mark style="color:purple;">.id\_sms\*</mark></p>                                                 | Int    | Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения.                |

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46" sms="Статус">Статус</state>
     <state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46" sms="Статус" viber="Статус">Статус</state>
     <state id_sms="ID SMS в системе для проверки статуса" time="2011-01-01 12:57:46" viber="Статус">Статус</state>
</response>
```

| Параметр                                                                                                            | Тип    | Описание                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ------------------------------------------------------------------------------------------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>response</p><p><mark style="color:orange;">.state</mark></p><p><mark style="color:purple;">\[id\_sms]</mark></p> | Int    | Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                     |
| <p>response</p><p><mark style="color:orange;">.state</mark></p><p><mark style="color:purple;">\[time]</mark></p>    | Date   | Время изменения статуса                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| <p>response</p><p><mark style="color:orange;">.state</mark></p>                                                     | String | <p></p><p>Последний статус сообщения:</p><ul><li>«send» - статус сообщения не получен. В этом случае передается пустой time (time="")</li><li>«not\_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем)</li><li>«expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный статус (не меняется со временем)</li><li>«deliver» - сообщение доставлено.</li><li>«read» - сообщение прочитано. Конечный статус (не меняется со временем) <em>для viber сообщения</em></li><li>«partly\_deliver» - сообщение было отправлено, но статус так и не был получен</li></ul> |
| <p>response</p><p><mark style="color:orange;">.state</mark></p><p><mark style="color:purple;">\[sms]</mark></p>     | String | Статус SMS сообщения.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| <p>response</p><p><mark style="color:orange;">.state</mark></p><p><mark style="color:purple;">\[viber]</mark></p>   | String | Статус Viber сообщения.                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |

## В случае возникновения ошибки в отправленном 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>
    <get_state>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
        <id_sms>IDSMS в системе для проверки статуса</id_sms>
    </get_state>
</request>
```

{% endtab %}

{% tab title="JSON" %}

Метод отправки **`POST`**

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

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

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

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

| Параметр   | Тип    | Описание                                                                                           |
| ---------- | ------ | -------------------------------------------------------------------------------------------------- |
| login\*    | String | Ваш логин в системе                                                                                |
| password\* | String | Ваш пароль в системе                                                                               |
| token\*    | String | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру |
| id\_sms\*  | Int    | Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения.                |
| detail     | Int    | 0 или 1 в случае необходимости получения кол-во частей и цены за одну часть сообщения              |

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

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

```json
[
    {
        "id_sms": 82216,
        "time_change_state": "2021-04-26 15:15:03",
        "state": "deliver",
        "num_parts": 1,
        "price": 10.6000000
    }
]
```

|                     |        |                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                        |
| ------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id\_sms             | Int    | Номер сообщения, полученный в ответном JSON-документа в процессе отправки сообщения                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| time\_change\_state | Date   | Время изменения статуса                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| state               | String | <p></p><p>Последний статус сообщения:</p><ul><li>«send» - статус сообщения не получен. В этом случае передается пустой time (time="")</li><li>«not\_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем)</li><li>«expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный статус (не меняется со временем)</li><li>«deliver» - сообщение доставлено.</li><li>«read» - сообщение прочитано. Конечный статус (не меняется со временем) <em>для viber сообщения</em></li><li>«partly\_deliver» - сообщение было отправлено, но статус так и не был получен</li></ul> |
| num\_parts          | String | Количество частей SMS                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| price               | String | Цена за одну часть SMS                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                 |

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

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

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

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

```json
{
  "login": "логин",
  "password": "пароль",
  "token":"токен",
  "id_sms": ID SMS в системе для проверки статуса,
  "detail" : 1
}
```

{% endtab %}

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

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

Все передаваемые значение необходимо закодировать.

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

| Параметр | Тип    | Описание                                                                                           |
| -------- | ------ | -------------------------------------------------------------------------------------------------- |
| user\*   | String | Ваш логин в системе                                                                                |
| pwd\*    | String | Ваш пароль в системе                                                                               |
| token\*  | String | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру |
| smsid\*  | Int    | Номер сообщения, полученный в ответном XML-документа в процессе отправки сообщения.                |

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

## Ответ на GET запрос

В ответ придет состояние **`state`** по переданному **`smsid`**, варианты ответа в таблице ниже.

## Ответ GET запроса статуса

| Параметр | Тип    | Описание                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| -------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| state    | String | <p></p><p>Последний статус сообщения:</p><ul><li>«send» - статус сообщения не получен. В этом случае передается пустой time (time="")</li><li>«not\_deliver» - сообщение не было доставлено. Конечный статус (не меняется со временем)</li><li>«expired» - абонент находился не в сети в те моменты, когда делалась попытка доставки. Конечный статус (не меняется со временем)</li><li>«deliver» - сообщение доставлено.</li><li>«read» - сообщение прочитано. Конечный статус (не меняется со временем) <em>для viber сообщения</em></li><li>«partly\_deliver» - сообщение было отправлено, но статус так и не был получен</li></ul> |

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

```
http://my.smsclub24.ru/sendsms.php?user=пользователь&pwd=пароль&smsid=ID_SMS
```

{% endtab %}
{% endtabs %}