.. role:: raw-html-m2r(raw)
   :format: html


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

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

.. list-table::
   :header-rows: 1

   * - Канал отправки
   * - SMS
   * - FLASHCALL
   * - TEXT_TO_SPEECH
   * - VIBER
   * - WHATSAPP
   * - VK
   * - PUSH
   * - WEASY
   * - TELEGRAM
   * - MMS
   * - TELEGRAM GATEWAY
   * - VOICECODE


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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

   * - Значение
     - Описание
   * - not_delivered
     - Следующее каскадное сообщение формируется при неполучении данным сообщением статуса delivered за время жизни
   * - not_read
     - Следующее каскадное сообщение формируется при неполучении данным сообщением статуса read за время жизни


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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

   * - Значение
     - Описание
   * - NUMBER_VERIFIED
     - Код подтвержден
   * - WRONG_CODE
     - Абонент ввел неверный код


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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

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


Скорость рассылки :raw-html-m2r:`<a href="#dispatch_velocity" id="dispatch_velocity"></a>`
----------------------------------------------------------------------------------------------

.. list-table::
   :header-rows: 1

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


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

.. code-block::

   "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"``

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

.. list-table::
   :header-rows: 1

   * - Канал
   * - SMS
   * - VIBER


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

.. list-table::
   :header-rows: 1

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


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

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

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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

   * - Статус
     - Описание
   * - PRE_REVIEW
     - Находится на премодерации
   * - AWAITING
     - Отклонено на стадии премодерации (Требуется уточнение данных)
   * - INTERNAL_REVIEW
     - Находится на рассмотрении менеджером
   * - EXTERNAL_REVIEW
     - Находится на рассмотрении оператором
   * - REJECTED
     - :raw-html-m2r:`<p>Отклонено оператором <br>(Требуется уточнение данных) </p>`
   * - APPROVED
     - Имя отправителя зарегистрировано
   * - CLOSED
     - Имя отправителя закрыто


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

.. list-table::
   :header-rows: 1

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


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

.. list-table::
   :header-rows: 1

   * - Статус
     - Описание
   * - INTERNAL_REVIEW
     - Находится на рассмотрении менеджером
   * - EXTERNAL_REVIEW
     - Находится на рассмотрении оператором
   * - REJECTED
     - Отклонено оператором
   * - APPROVED
     - Имя отправителя зарегистрировано
   * - CLOSED
     - Имя отправителя закрыто

 
.. toctree::
   :hidden: