> 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/poluchenie-spiska-otpravitelei.md).

# Получение списка отправителей

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

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

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

Адрес для запроса: **`https://my.smsclub24.ru/xml/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 | Вместо логина и пароля можно использовать секретный ключ. Для его получения обратитесь к менеджеру |

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

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

```xml
<?xml version="1.0" encoding="utf-8" ?>
<response>
     <any_originator>FALSE</any_originator>
     <list_originator>
          <originator MCC="МСС" MNC="МНС" template="шаблон" comment="комментарий" history="комментарий" operator="оператор" state="rejected" type_sending="sms" type_traffic="multi">Отправитель</originator>
     </list_originator>
</response>
```

| Параметр                                                                                                                                                                                 | Тип    | Описание                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| <p>response</p><p><mark style="color:orange;">.any\_originator</mark></p>                                                                                                                | String | <p></p><p>TRUE/FALSE - может ли клиент отправлять от любого отправителя или только от заранее одобренных.</p><ul><li>Если TRUE, то клиент может использовать любого отправителя. При этом список отправителей не возвращается.</li><li>Если FALSE, то клиент может использовать только отправителей со статусом «ready»</li></ul>                                                                                                                                                                                                                                                                                      |
| <p>response</p><p><mark style="color:orange;">.list\_originator</mark></p><p><mark style="color:purple;">.originator</mark></p><p><mark style="color:green;">\[state]</mark></p>         | String | <p></p><p>Статус отправителя:</p><ul><li>«order» – оформляется</li><li>«ready» - готов к использованию</li><li>«rejected» – отклонен</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
| <p>response</p><p><mark style="color:orange;">.list\_originator</mark></p><p><mark style="color:purple;">.originator</mark></p><p><mark style="color:green;">\[mcc]</mark></p>           | String | Мобильный код страны                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| <p>response</p><p><mark style="color:orange;">.list\_originator</mark></p><p><mark style="color:purple;">.originator</mark></p><p><mark style="color:green;">\[mnc]</mark></p>           | String | Мобильный код оператора                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                |
| <p>response</p><p><mark style="color:orange;">.list\_originator</mark></p><p><mark style="color:purple;">.originator</mark></p><p><mark style="color:green;">\[template]</mark></p>      | String | Наименование шаблона                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                   |
| <p>response</p><p><mark style="color:orange;">.list\_originator</mark></p><p><mark style="color:purple;">.originator</mark></p><p><mark style="color:green;">\[comment]</mark></p>       | String | Комментарий клиента                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| <p>response</p><p><mark style="color:orange;">.list\_originator</mark></p><p><mark style="color:purple;">.originator</mark></p><p><mark style="color:green;">\[history]</mark></p>       | String | Комментарий менеджера                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                  |
| <p>response</p><p><mark style="color:orange;">.list\_originator</mark></p><p><mark style="color:purple;">.originator</mark></p><p><mark style="color:green;">\[operator]</mark></p>      | String | Используемое направление                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                               |
| <p>response</p><p><mark style="color:orange;">.list\_originator</mark></p><p><mark style="color:purple;">.originator</mark></p><p><mark style="color:green;">\[type\_sending]</mark></p> | String | <p></p><p>Тип отправителя. Возможные значения:</p><ul><li>sms</li><li>flashsms</li><li>wappush</li><li>vcard</li><li>silence</li><li>viber</li><li>vk</li><li>telegram</li><li>whatsapp</li><li>skype</li><li>facebook</li><li>e\_mail</li><li>voice</li><li>voice\_ivr</li><li>hlr</li><li>pingsms</li><li>flashcall</li><li>twitter</li><li>instagram</li><li>hangouts</li><li>yandex</li><li>icq</li><li>wechat</li><li>qq</li><li>snapchat</li><li>discord</li><li>line</li><li>hlr\_whatsapp</li><li>hlr\_telegram</li><li>hlr\_viber</li><li>hlr\_voice</li><li>hlr\_voice\_ivr</li><li>hlr\_flashcall</li></ul> |
| <p>response</p><p><mark style="color:orange;">.list\_originator</mark></p><p><mark style="color:purple;">.originator</mark></p><p><mark style="color:green;">\[type\_traffic]</mark></p> | String | <p></p><p>Тип трафика. Возможные значения</p><ul><li>multi</li><li>transaction</li><li>service</li><li>commercial</li><li>authorization</li></ul>                                                                                                                                                                                                                                                                                                                                                                                                                                                                      |

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