# Добавление отправителей

{% hint style="info" %}
Отправитель может состоять только из 11-ти латинских символов, цифр, пробелов и знаков "'?><,.-\_=+/"!@#$%^&\*() " или 15-ти цифр
{% endhint %}

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/add_originator.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;">.originator*</mark></p>                                                                                                  | String | Отправитель, которого нужно добавить                                                               |
| <p>request</p><p><mark style="color:orange;">.originator</mark></p><p><mark style="color:purple;">[inn]</mark></p>                                                    | Int    | ИНН организации                                                                                    |
| <p>request</p><p><mark style="color:orange;">.originator</mark></p><p><mark style="color:purple;">[kpp]</mark></p>                                                    | Int    | КПП организации                                                                                    |
| <p>request</p><p><mark style="color:orange;">.originator</mark></p><p><mark style="color:purple;">[ogrn]</mark></p>                                                   | Int    | ОГРН организации                                                                                   |
| <p>request</p><p><mark style="color:orange;">.originator</mark></p><p><mark style="color:purple;">[name_counterparty]</mark></p>                                      | String | Имя контрагента                                                                                    |
| <p>request</p><p><mark style="color:orange;">.originator</mark></p><p><mark style="color:purple;">[template]</mark></p>                                               | String | Текст шаблона                                                                                      |
| <p>request</p><p><mark style="color:orange;">.originator</mark></p><p><mark style="color:purple;">[comment]</mark></p>                                                | String | Комментарий                                                                                        |
| <p>request</p><p><mark style="color:orange;">.operator</mark></p><p><mark style="color:purple;">[mcc]</mark></p>                                                      | Int    | Мобильный код страны                                                                               |
| <p>request</p><p><mark style="color:orange;">.operator</mark></p><p><mark style="color:purple;">[mnc]</mark></p>                                                      | Int    | Мобильный код оператора                                                                            |
| <p>request</p><p><mark style="color:orange;">.file</mark></p><p><mark style="color:purple;">[href]</mark></p>                                                         | String | Ссылка на загружаемый файл                                                                         |
| <p>request</p><p><mark style="color:orange;">.file</mark></p><p><mark style="color:purple;">[id]</mark></p>                                                           | Int    | Id загружаемого файла                                                                              |

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <originator id_originator="">Отправитель поставлен в очередь на регистрацию.</originator>
</response>
```

| Параметр                                                                                                                      | Тип    | Описание                                                                                                                                                                                                                                                                                                                              |
| ----------------------------------------------------------------------------------------------------------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>response</p><p><mark style="color:orange;">.originator</mark></p>                                                          | String | <p></p><p>Результат добавления отправителя. Может содержать следующие значения:</p><ul><li>Отправитель добавлен.</li><li>Отправитель поставлен в очередь на регистрацию.</li><li>Отправитель может состоять только из 11-ти латинских символов, цифр, пробелов и знаков "\'?>&#x3C;,.-_=+/"!@#$%^&#x26;*() " или 15-ти цифр</li></ul> |
| <p>response</p><p><mark style="color:orange;">.originator</mark></p><p><mark style="color:purple;">[id_originator]</mark></p> | Int    | Уникальный номер отправителя в системе                                                                                                                                                                                                                                                                                                |

## В случае возникновения ошибки в отправленном 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>
    <originator INN="ИНН" KPP="КПП" OGRN="ОГРН" name_counterparty="имя контрагента" template="текст шаблона" comment="комментарий">Отправитель</originator>
    <operator MCC="" MNC=""/>
    …
    <operator MCC="" MNC=""/>
    <file href="http://..." id="1" />
    …
    <file href="http://..." id="4" />
</request>
```
{% endtab %}
{% endtabs %}
