# Справочники

## Каналы трафика <a href="#channel-types" id="channel-types"></a>

| Канал отправки   |
| ---------------- |
| SMS              |
| FLASHCALL        |
| TEXT\_TO\_SPEECH |
| VIBER            |
| WHATSAPP         |
| VK               |
| PUSH             |
| WEASY            |
| TELEGRAM         |
| MMS              |
| TELEGRAM GATEWAY |
| VOICECODE        |

## Способы отправки сообщений <a href="#sending-methods" id="sending-methods"></a>

| Способ отправки  | Описание                                                             |
| ---------------- | -------------------------------------------------------------------- |
| API              | Сообщение отправлено через API                                       |
| UI               | Сообщение отправлено через web-интерфейс ЛК Direct                   |
| VERIFIER\_API    | Сообщение отправлено через модуль подтверждения телефона без виджета |
| VERIFIER\_WIDGET | Сообщение отправлено через модуль подтверждения телефона с виджетом  |

## Направления сообщений <a href="#directions" id="directions"></a>

| Направление | Описание            |
| ----------- | ------------------- |
| outbound    | Исходящее сообщение |
| inbound     | Входящее сообщение  |

## Типы трафика <a href="#traffic-types" id="traffic-types"></a>

| Тип трафика | Описание               |
| ----------- | ---------------------- |
| PROMO       | Рекламный трафик       |
| SERVICE     | Сервисный трафик       |
| AUTHORIZE   | Авторизационный трафик |
| TRANSACT    | Транзакционный трафик  |

## Основные статусы сообщений <a href="#message-states" id="message-states"></a>

| Статус сообщения | Описание                                 |
| ---------------- | ---------------------------------------- |
| delivered        | Доставлено (финальный статус)            |
| undelivered      | Не доставлено (финальный статус)         |
| unsent           | Не отправлено (финальный статус)         |
| sent             | Отправлено; находится в ожидании статуса |
| sending          | В ожидании отправки                      |

## Статусы прочтения сообщений <a href="#message-read-states" id="message-read-states"></a>

| Статус прочтения | Описание                                                               |
| ---------------- | ---------------------------------------------------------------------- |
| read             | Прочитано; доступен для каналов: VIBER, VK                             |
| unread           | Не прочитано за время жизни сообщения; доступен для каналов: VIBER, VK |

## Типы содержимого сообщений <a href="#message-content-types" id="message-content-types"></a>

| Тип    | Описание                                      |
| ------ | --------------------------------------------- |
| text   | Текстовое сообщение                           |
| button | Сообщение с интерактивными элементами (VIBER) |
| image  | Сообщение с графическим вложением (VIBER)     |

## Условия формирования каскадных сообщений <a href="#cascade-conditions" id="cascade-conditions"></a>

| Значение       | Описание                                                                                                     |
| -------------- | ------------------------------------------------------------------------------------------------------------ |
| not\_delivered | Следующее каскадное сообщение формируется при неполучении данным сообщением статуса delivered за время жизни |
| not\_read      | Следующее каскадное сообщение формируется при неполучении данным сообщением статуса read за время жизни      |

## События для отправки callback <a href="#callback-events" id="callback-events"></a>

| Значение  | Описание                                                                                                      |
| --------- | ------------------------------------------------------------------------------------------------------------- |
| delivered | <p>Получение сообщением одного из статусов:</p><ul><li>delivered</li><li>undelivered</li><li>unsent</li></ul> |
| sent      | Получение сообщением статуса sent                                                                             |
| read      | <p>Получение сообщением одного из статусов:</p><ul><li>read</li><li>unread</li></ul>                          |
| price     | Изменение цены сообщения                                                                                      |
| click     | Переход по сокращенной ссылке из сообщения                                                                    |

## Результат отправки FlashCall <a href="#flashcall-result" id="flashcall-result"></a>

| Значение         | Описание                  |
| ---------------- | ------------------------- |
| NUMBER\_VERIFIED | Код подтвержден           |
| WRONG\_CODE      | Абонент ввел неверный код |

## Облака отправки PUSH-сообщений <a href="#push-platforms" id="push-platforms"></a>

| Значение |
| -------- |
| APNS     |
| FCM      |
| HCM      |

## Статусы рассылок <a href="#dispatch-states" id="dispatch-states"></a>

| Статус    | Описание                                                                                   |
| --------- | ------------------------------------------------------------------------------------------ |
| initiated | Рассылка находится в процессе создания                                                     |
| changing  | Переходный статус: рассылка находится в процессе обновления статуса                        |
| scheduled | Рассылка запланирована: время начала еще не наступило                                      |
| sending   | Рассылка отправляется                                                                      |
| awaiting  | Все сообщения рассылки отправлены, ожидаются статусы                                       |
| done      | Все сообщения рассылки отправлены и все статусы сообщений установлены *(финальный статус)* |
| paused    | Рассылка поставлена на паузу                                                               |
| stopped   | Рассылка остановлена *(финальный статус)*                                                  |

## Скорость рассылки <a href="#dispatch_velocity" id="dispatch_velocity"></a>

| Значение rateTerm | Описание                                                                                                                               |
| ----------------- | -------------------------------------------------------------------------------------------------------------------------------------- |
| d                 | количество сообщений, отправляемых в сутки, **с учетом разрешенных часов отправки**, гарантированно не превысит значение `rate` :star: |
| h                 | количество сообщений, отправляемых в час, гарантированно не превысит значение `rate`                                                   |
| m                 | количество сообщений, отправляемых в минуту, гарантированно не превысит значение `rate`                                                |

&#x20;:star: Например, при создании рассылки с параметрами:

```
"rate": 100000,
"rateTerm": "d",
"hours": [10, 11, 12, 13, 14]
```

&#x20;количество сообщений `rate` будет отправлено в течение пяти допустимых часов отправки. Таким образом максимально допустимая скорость рассылки составит 20 000 сообщений в час.

Но если указать `"hours": [10, 11]`, то максимально допустимая скорость рассылки составит уже 50 000 в час.

:warning:Значение `hours` не учитывается при указании `"rateTerm": "h"` или `"rateTerm": "m"`

## Каналы имен отправителей <a href="#sender-name-channels" id="sender-name-channels"></a>

| Канал |
| ----- |
| SMS   |
| VIBER |

## Типы имен отправителей <a href="#sender-name-types" id="sender-name-types"></a>

| Тип            | Описание                            |
| -------------- | ----------------------------------- |
| PROMO          | Рекламное имя с абонентской платой  |
| MULTISIGNATURE | Мультиподпись без абонентской платы |

## Страны имен отправителей <a href="#sender-name-countries" id="sender-name-countries"></a>

У VIBER-отправителей присутствует строковый атрибут `countryCode`, значение которого соответствует двухбуквенному коду страны в соответствии с [ISO-3166](https://www.iso.org/iso-3166-country-codes.html)

## Операторы имен отправителей <a href="#sender-name-brands" id="sender-name-brands"></a>

| Используемое наименование | Оператор           |
| ------------------------- | ------------------ |
| MTS                       | МТС                |
| MEGAFON                   | Мегафон            |
| MOTIV                     | Мотив              |
| BEELINE                   | Билайн             |
| TELE2                     | Теле2              |
| ROSTELECOM                | Ростелеком         |
| TATTELECOM                | Таттелеком         |
| KTELECOM                  | К-телеком          |
| KTKTELECOM                | КТК ТЕЛЕКОМ        |
| EZMOBILE                  | Спринт (EZ Mobile) |
| VTBMOBILE                 | ВТБ Мобайл         |
| GPBMOBILE                 | Газпромбанк Мобайл |
| SBERMOBILE                | СберМобайл         |
| VTELECOM                  | Вайнах Телеком     |

## Статусы имен отправителей <a href="#sender-name-states" id="sender-name-states"></a>

| Статус           | Описание                                                      |
| ---------------- | ------------------------------------------------------------- |
| PRE\_REVIEW      | Находится на премодерации                                     |
| AWAITING         | Отклонено на стадии премодерации (Требуется уточнение данных) |
| INTERNAL\_REVIEW | Находится на рассмотрении менеджером                          |
| EXTERNAL\_REVIEW | Находится на рассмотрении оператором                          |
| REJECTED         | <p>Отклонено оператором <br>(Требуется уточнение данных) </p> |
| APPROVED         | Имя отправителя зарегистрировано                              |
| CLOSED           | Имя отправителя закрыто                                       |

## Типы шаблонов <a href="#template-types" id="template-types"></a>

| Тип       | Описание               |
| --------- | ---------------------- |
| SERVICE   | Сервисный шаблон       |
| AUTHORIZE | Авторизационный шаблон |
| TRANSACT  | Транзакционный шаблон  |
| MARKETING | Рекламный шаблон       |

## Статусы шаблонов <a href="#templates-states" id="templates-states"></a>

| Статус           | Описание                             |
| ---------------- | ------------------------------------ |
| INTERNAL\_REVIEW | Находится на рассмотрении менеджером |
| EXTERNAL\_REVIEW | Находится на рассмотрении оператором |
| REJECTED         | Отклонено оператором                 |
| APPROVED         | Имя отправителя зарегистрировано     |
| CLOSED           | Имя отправителя закрыто              |


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://api.docs.direct.i-dgtl.ru/extra/references.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
