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

Спецификация для получения списка отправителей: XML

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

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

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

Адрес для запроса: **`https://my3.webcom.mobi/xml/originator.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>
     <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>
```

<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;">.any_originator</mark></p></td><td>String</td><td><p>TRUE/FALSE - может ли клиент отправлять от любого отправителя или только от заранее одобренных. </p><ul><li>Если TRUE, то клиент может использовать любого отправителя. При этом список отправителей не возвращается. </li><li>Если FALSE, то клиент может использовать только отправителей со статусом «ready»</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[state]</mark></p></td><td>String</td><td><p>Статус отправителя:</p><ul><li>«order» – оформляется</li><li>«ready» - готов к использованию</li><li>«rejected» – отклонен</li></ul></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[mcc]</mark></p></td><td>String</td><td>Мобильный код страны</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[mnc]</mark></p></td><td>String</td><td>Мобильный код оператора</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[template]</mark></p></td><td>String</td><td>Наименование шаблона</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[comment]</mark></p></td><td>String</td><td>Комментарий клиента</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[history]</mark></p></td><td>String</td><td>Комментарий менеджера</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[operator]</mark></p></td><td>String</td><td>Используемое направление</td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[type_sending]</mark></p></td><td>String</td><td><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></td></tr><tr><td><p>response</p><p><mark style="color:blue;">.list_originator</mark></p><p><mark style="color:green;">.originator</mark></p><p><mark style="color:orange;">[type_traffic]</mark></p></td><td>String</td><td><p>Тип трафика. Возможные значения </p><ul><li>multi</li><li>transaction</li><li>service</li><li>commercial </li><li>authorization</li></ul></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 %}
{% endtabs %}