# Структура основной реляционной базы данных Webim Server 10.8

Статья описывает состав таблиц основной реляционной базы данных **Webim Server 10.8**.

**Webim Server** размещает накапливаемый при работе контент в нескольких типах хранилищ:

  * в файловой системе (на файл-сервере) — настройки инсталляции, сертификаты, аватары и файлы, которые передают посетители и операторы;

  * в реляционной СУБД (**PostgreSQL**, **MySQL**) — операционные данные: аккаунты, операторы, чаты, сообщения, посетители, категории, опросы и настройки;

  * в колоночной СУБД (**ClickHouse**) — данные **Статистики** и Панели приборов;

  * в поисковом движке (**Elasticsearch** или **OpenSearch**, опционально) — индекс [истории диалогов](https://webim.ru/kb/for-admins/view-dialog-history.html);

  * в резидентной СУБД (**Redis**) — служебные данные для **Chat Backend** и [масштабирования **Admin Backend**](https://webim.ru/kb/devops/scaling/admin-backend-scaling.html).

Эта статья посвящена **реляционной** БД. Требования к хранилищам — в статье [Требования к хранилищу](https://webim.ru/kb/devops/sys-reqs-for-server/sys-reqs-server-db.html).

Как `meta` и `pro` выглядят в **MySQL** и **PostgreSQL** и как задаются в `db.json` — в разделе [Верхнеуровневая структура основной БД](https://webim.ru/kb/devops/db-configuration.html#main-db-layout).

Создание и обновление схем — в статье [Менеджмент БД через wmdb](https://webim.ru/kb/devops/wmdb.html).

## Хранилища `meta` и `pro`

Большинство данных реляционной СУБД лежат в двух независимых пространствах имён:

  * `meta` (исторические имена БД/схемы — `webim_site`, `webim_hosted_meta`) — общие данные инсталляции: базовые данные аккаунта, операторы, тарифы.

  * `pro` — операционные данные аккаунта: чаты, сообщения, посетители, настройки аккаунта. Имя: `webim_service_pro_<имя_аккаунта>`.

Базовая информация об аккаунте хранится в таблице `account` хранилища `meta`. Данные из других таблиц `meta` связаны с аккаунтом полем `accountname` (часто это внешний ключ). Такое разделение нужно и облаку **Webim**, и размещению на мощностях заказчика: обращения к `meta` и к `pro` идут через разные соединения.

СУБД рекомендуется размещать на выделенных серверах, не разделяя их с другим ПО.

Типы полей приведены в соответствии с логической схемой. Между **MySQL** и **PostgreSQL** конкретный DDL может отличаться (кодировки, варианты `TEXT`/`JSONB`, индексы).

У части колонок `TIMESTAMPTZ` в метаданных задан `DEFAULT '1970-01-02 00:00:00'`. Это **технический плейсхолдер пустой даты** (константа `datetime_default_value` в `wmdb`), а не рабочее значение вроде «блокировка до…» или «пароль изменён тогда-то». Строка выбрана вместо Unix epoch `1970-01-01 00:00:00`: тип `TIMESTAMP` в **MySQL** в ряде часовых поясов такое значение не принимает. На уже существующих инсталляциях фактический `DEFAULT` в СУБД может отличаться; в выборке то же мгновение иногда видно как `1970-01-01 21:00:00` (это `1970-01-02 00:00:00` в поясе UTC+3).

## Структура баз данных

На следующих EER-диаграммах показаны сущности и связи основной реляционной БД **Webim** версии **10.8**. Связи построены по объявленным в метаданных внешним ключам и по однозначным ссылкам внутри той же схемы (например, `chatmessage.threadid` → `chatthread.threadid`). Операторы живут в `meta`, поэтому поля вроде `operatorid` в таблицах `pro` на диаграмме `pro` ребрами не связаны.

![Схема хранилища meta](https://webim.ru/kb/img/devops/db-structure/webim_meta_eer_10_8.svg){ style="width: 4137px; max-width: 100%" }

![Схема хранилища pro](https://webim.ru/kb/img/devops/db-structure/webim_pro_eer_10_8.svg){ style="width: 4405px; max-width: 100%" }

## Описание таблиц хранилища `meta` { #meta }

Принятые именования хранилища: `webim_site`, `webim_hosted_meta`.

| Таблица | Назначение                                                                                                                                                                  |
| --- |-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| [`account`](#meta-account) | Соответствует аккаунтам **Webim**.                                                                                                                                          |
| [`accountenv`](#meta-accountenv) | Параметры окружения аккаунта в инфраструктуре (сервер, окружение, порт **Chat Backend**).                                                                                   |
| [`accountkeyvalue`](#meta-accountkeyvalue) | Абстрактное key-value хранилище для аккаунтов. В коде используется, в том числе, для включения **Data Storager** для аккаунтов со значением `1` соответствующего параметра. |
| [`accountsentstats`](#meta-accountsentstats) | Служебная таблица для отправки статистики на электронную почту.                                                                                                             |
| [`authtoken`](#meta-authtoken) | Токены авторизации операторов.                                                                                                                                              |
| [`ban`](#meta-ban) | Устарело, не используется.                                                                                                                                                  |
| [`channelaccount`](#meta-channelaccount) | Привязка каналов общения к аккаунту.                                                                                                                                        |
| [`chat`](#meta-chat) | Устаревшая таблица. При размещении на мощностях заказчика не используется.                                                                                                  |
| [`chatoperator`](#meta-chatoperator) | Операторы (учётные записи сотрудников).                                                                                                                                     |
| [`chatoperatoraccount`](#meta-chatoperatoraccount) | Связь оператора с аккаунтом и его роли в этом аккаунте.                                                                                                                     |
| [`globalsettings`](#meta-globalsettings) | Глобальные настройки инсталляции.                                                                                                                                           |
| [`invoice`](#meta-invoice) | Счета на оплату.                                                                                                                                                            |
| [`loginattempt`](#meta-loginattempt) | Попытки входа операторов. В таблице хранятся неудачные попытки.                                                                                                             |
| [`operatordevice`](#meta-operatordevice) | Устройства, с которых оператор работает в системе.                                                                                                                          |
| [`orderedservice`](#meta-orderedservice) | Заказы услуг (тарифные периоды).                                                                                                                                            |
| [`organization`](#meta-organization) | Реквизиты организации-плательщика.                                                                                                                                          |
| [`promocode`](#meta-promocode) | Промокоды.                                                                                                                                                                  |
| [`recurringpaymentprofile`](#meta-recurringpaymentprofile) | Профили автоплатежей.                                                                                                                                                       |
| [`service_user`](#meta-service-user) | Служебная таблица, у hosted-клиентов не используется.                                                                                                                       |
| [`support_user`](#meta-support-user) | Служебная таблица, у hosted-клиентов не используется.                                                                                                                       |
| [`tariff`](#meta-tariff) | Тарифы.                                                                                                                                                                     |
| [`webim_pro_writeoff`](#meta-webim-pro-writeoff) | История списаний средств с баланса аккаунта.                                                                                                                                |

Представления (views) в этой схеме:

  * `accountfororderedservicedailyprocessing`,

  * `accounttariffview`,

  * `endingaccountview`,

  * `lastorderedserviceidview`,

  * `operatoraccountview`,

  * `orderedserviceforautoreorderview`.

Они строятся поверх таблиц и отдельно в перечне полей не описываются.

### `account` { #meta-account }

Соответствует аккаунтам **Webim**.

Большинство полей связаны с оплатой и при размещении на мощностях заказчика не используются: обычно это один аккаунт.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `accountid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор аккаунта **Webim**. |
| `accountname` | `VARCHAR(255)` | NOT NULL, DEFAULT '' | Имя аккаунта. |
| `dtmcreated` | `TIMESTAMPTZ` | NOT NULL, DEFAULT now() | Дата создания аккаунта. |
| `closedate` | `DATE` | — | Дата закрытия аккаунта. |
| `status` | `INT` | NOT NULL | Служебный статус аккаунта. |
| `registertoken` | `VARCHAR(255)` | — | Токен активации аккаунта при регистрации. |
| `partner` | `VARCHAR(256)` | — | Имя партнёра, через которого зарегистрирован аккаунт. |
| `ratetype` | `VARCHAR(64)` | DEFAULT 'operators_in_system' | Тип тарификации. По умолчанию `operators_in_system` — по числу операторов в системе. |
| `tariff_settings` | `LONGTEXT` | — | Настройки тарифа. |
| `rate_settings` | `VARCHAR(256)` | — | Дополнительные параметры тарификации. |
| `money_amount` | `DECIMAL(10, 2)` | NOT NULL, DEFAULT '0.00' | Баланс аккаунта. |
| `timeonline` | `TIMESTAMPTZ` | — | Метка времени активности аккаунта. |
| `dtmwriteoff` | `TIMESTAMPTZ` | — | Дата списания. |
| `profreedate` | `DATE` | — | Дата окончания бесплатного (пробного) периода. |
| `site` | `VARCHAR(64)` | — | Сайт заказчика, указанный при регистрации. |
| `phone` | `VARCHAR(128)` | — | Телефон. |
| `comments` | `LONGTEXT` | — | Комментарии. |
| `dtmprolongated` | `TIMESTAMPTZ` | — | Дата продления аккаунта. |
| `server_ip` | `CHAR(16)` | — | IP-адрес сервера. |
| `tornado_port` | `INT` | — | Порт **Chat Backend**. |
| `load_weight` | `INT` | — | Вес нагрузки аккаунта. |
| `isinzoho0` | `INT` | — | Служебный признак выгрузки аккаунта в CRM Zoho. |
| `isinzoho` | `TIMESTAMPTZ` | — | Момент выгрузки аккаунта в CRM Zoho. |
| `pay_type` | `VARCHAR(16)` | — | Способ оплаты. |
| `tariff` | `VARCHAR(32)` | NOT NULL, DEFAULT 'test' | Ключ тарифа. |
| `version` | `VARCHAR(12)` | — | Версия **Webim Server**, зафиксированная для аккаунта. |
| `major_version` | `INT` | — | Старший номер версии **Webim Server**. |
| `version_checked_dtm` | `DATETIME_TIMESTAMPTZ` | — | Момент последней проверки версии сервера. |
| `partner_discount` | `DECIMAL(10, 2)` | DEFAULT '0.80' | Скидка партнёра. |
| `cms_used` | `VARCHAR(100)` | — | CMS, указанная при регистрации. |
| `planned_operators` | `VARCHAR(16)` | — | Планируемое число операторов. |
| `is_partner_client` | `BOOLEAN` | — | Признак, что аккаунт принадлежит клиенту партнёра. |
| `chat_used` | `VARCHAR(45)` | — | Сведения об использовании чата, указанные при регистрации. |
| `promocode` | `VARCHAR(32)` | — | Промокод, применённый к аккаунту. |
| `timezone` | `VARCHAR(45)` | — | Часовой пояс аккаунта. |
| `userinfo` | `LONGTEXT` | — | Дополнительные сведения о заказчике, указанные при регистрации. |
| `last_db_backup_dtm` | `DATETIME_TIMESTAMPTZ` | — | Момент последнего резервного копирования БД аккаунта. |
| `isblocked` | `BOOLEAN` | NOT NULL, DEFAULT '0' | Признак блокировки аккаунта. |
| `dtmblocked` | `DATE` | — | Дата блокировки аккаунта. |
| `for_test` | `BOOLEAN` | — | Признак тестового аккаунта. |
| `server_name_src` | `VARCHAR(4)` | NOT NULL, DEFAULT 's1' | Идентификатор сервера. |

Индексы:

  * `idx_account_accountname` (`accountname`) (unique)
  * `fk_account_tariff` (`tariff`)
  * `idx_account_promocode` (`promocode`)

### `accountenv` { #meta-accountenv }

Параметры окружения аккаунта в облачной инфраструктуре **Webim** (сервер, окружение, порт **Chat Backend**).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `accountname` | `VARCHAR(255)` | NOT NULL, DEFAULT '' | Имя аккаунта. |
| `server_name_src` | `VARCHAR(4)` | NOT NULL, DEFAULT 's1' | Идентификатор сервера. |
| `env_src` | `VARCHAR(32)` | NOT NULL, DEFAULT 'eta' | Имя окружения. |
| `cb_port_src` | `INT` | NOT NULL, DEFAULT '8260' | Порт **Chat Backend**. |
| `updated_at` | `DATETIME_TIMESTAMPTZ` | DEFAULT now() | Момент изменения. |
| `created_at` | `DATETIME_TIMESTAMPTZ` | DEFAULT now() | Момент создания. |

### `accountkeyvalue` { #meta-accountkeyvalue }

Абстрактное key-value хранилище настроек для аккаунтов. В коде используется, в том числе, для включения **Data Storager**.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `accountname` | `VARCHAR(64)` | NOT NULL | Имя аккаунта. |
| `key` | `VARCHAR(64)` | NOT NULL | Ключ. |
| `value` | `TEXT` | — | Значение. |
| `ts` | `TIMESTAMPTZ` | — | Момент записи. |

Индексы:

  * `idx_accountkeyvalue_accountname_key` (`accountname`, `key`)

### `accountsentstats` { #meta-accountsentstats }

Служебная таблица для отправки статистики на электронную почту, нужна, если рассылка статистики используется.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `dtm` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата, за которую сформирована рассылка. |
| `accountname` | `VARCHAR(255)` | FK → `account.accountname`, NOT NULL | Имя аккаунта. |
| `period` | `ENUM('daily', 'weekly', 'manual')` | NOT NULL | Период рассылки: ежедневно, еженедельно или вручную. |
| `subject` | `TEXT` | NOT NULL | Тема письма. |
| `address` | `TEXT` | NOT NULL | Адрес получателя. |
| `calc_dtm` | `DATETIME_TIMESTAMPTZ` | — | Момент расчёта статистики для письма. |

### `authtoken` { #meta-authtoken }

Токены авторизации операторов.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор токена. |
| `created` | `TIMESTAMPTZ` | NOT NULL, DEFAULT now() | Дата создания токена. |
| `modified` | `TIMESTAMPTZ` | DEFAULT '1970-01-02 00:00:00' (плейсхолдер) | Дата последнего изменения. |
| `operatorid` | `INT UNSIGNED` | FK → `chatoperator.operatorid`, NOT NULL | Идентификатор оператора. |
| `authtoken` | `VARCHAR(60)` | DEFAULT '' | Токен. |
| `hash` | `VARCHAR(32)` | — | Хеш. |
| `useragent` | `LONGTEXT` | — | Заголовок User-Agent. |
| `ip` | `VARCHAR(15)` | — | IP-адрес. |
| `persistent` | `INT` | — | Флаг сохранения сессии (чекбокс «Запомнить» при входе). |
| `deviceid` | `VARCHAR(64)` | — | Идентификатор устройства оператора. |
| `bdl` | `VARCHAR(128)` | — | Признак служебного (backdoor) входа поддержки. Для обычных сессий оператора поле пустое. |
| `lastaccessip` | `VARCHAR(15)` | — | IP-адрес последнего обращения с этим токеном. |

Индексы:

  * `idx_authtoken_operatorid` (`operatorid`)

### `ban` { #meta-ban }

Устаревшая информация, таблица не используется.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT UNSIGNED` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `created` | `DATETIME_TIMESTAMPTZ` | — | Дата начала блокировки. |
| `till` | `DATETIME_TIMESTAMPTZ` | DEFAULT '2020-01-01 00:00:00' | Дата окончания блокировки. |
| `address` | `VARCHAR(50)` | — | Заблокированный IP-адрес. |
| `comment` | `VARCHAR(255)` | — | Комментарий оператора. |
| `json` | `LONGTEXT` | — | Дополнительные данные. |

### `channelaccount` { #meta-channelaccount }

Привязка каналов общения к аккаунту.

| Поле | Тип | Ограничения | Описание                                   |
| --- | --- | --- |--------------------------------------------|
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи.                      |
| `externalchannelid` | `TEXT` | — | Внешний идентификатор канала у провайдера. |
| `channelid` | `VARCHAR(32)` | NOT NULL | Идентификатор канала общения.              |
| `channeltype` | `VARCHAR(32)` | NOT NULL | Тип канала общения.                        |
| `channelsecretkey` | `VARCHAR(32)` | NOT NULL | Секретный ключ канала.                     |
| `accountname` | `VARCHAR(255)` | NOT NULL | Имя аккаунта.                              |
| `hostedbaseurl` | `VARCHAR(64)` | — | Устарело, не используется.                 |

### `chat` { #meta-chat }

Устаревшая таблица. При размещении на мощностях заказчика не используется.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `accountname` | `VARCHAR(255)` | — | Имя аккаунта. |
| `ip` | `VARCHAR(50)` | — | IP-адрес посетителя. |
| `chattext` | `LONGTEXT` | — | Текст переписки. |
| `created` | `DATETIME_TIMESTAMPTZ` | — | Момент создания. |
| `sessionid` | `VARCHAR(40)` | — | Идентификатор сессии. |
| `useragent` | `LONGTEXT` | — | Заголовок User-Agent. |
| `platform` | `VARCHAR(15)` | — | Платформа посетителя. |

### `chatoperator` { #meta-chatoperator }

Операторы (учётные записи сотрудников).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `operatorid` | `INT UNSIGNED` | PK, NOT NULL, autoincrement | Идентификатор оператора. |
| `fullname` | `VARCHAR(128)` | NOT NULL | Отображаемое имя. |
| `email` | `VARCHAR(128)` | NOT NULL | Адрес электронной почты. |
| `created` | `TIMESTAMPTZ` | NOT NULL, DEFAULT now() | Момент создания. |
| `password` | `VARCHAR(128)` | NOT NULL | Хеш пароля. |
| `recoverytoken` | `VARCHAR(128)` | — | Токен восстановления пароля. |
| `recoverytime` | `TIMESTAMPTZ` | — | Срок действия токена восстановления пароля. |
| `deleted` | `TIMESTAMPTZ` | — | Признак или момент удаления. |
| `operatororder` | `INT` | NOT NULL, DEFAULT '100' | Порядок сортировки оператора в списках. |
| `avatar` | `VARCHAR(255)` | — | Путь к файлу аватара. |
| `login` | `VARCHAR(128)` | — | Логин оператора (если задан отдельно от email). |
| `answers` | `TEXT` | — | Персональные шаблоны ответов оператора. |
| `subscribed` | `TINYINT` | DEFAULT '0' | Признак подписки на уведомления. |
| `config` | `LONGTEXT` | — | Персональные настройки оператора. |
| `passwordmodified` | `TIMESTAMPTZ` | DEFAULT '1970-01-02 00:00:00' (плейсхолдер) | Момент последней смены пароля. |

Индексы:

  * `idx_chatoperator_email` (`email`)

### `chatoperatoraccount` { #meta-chatoperatoraccount }

Связь оператора с аккаунтом и его роли в этом аккаунте.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `operatoraccountid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор связи оператора с аккаунтом. |
| `operatorid` | `INT UNSIGNED` | FK → `chatoperator.operatorid`, NOT NULL | Идентификатор оператора. |
| `accountname` | `VARCHAR(255)` | FK → `account.accountname`, NOT NULL, DEFAULT '' | Имя аккаунта. |
| `roles` | `VARCHAR(255)` | NOT NULL, DEFAULT 'operator' | Роль оператора в аккаунте (`admin` / `supervisor` / `operator` и пользовательские роли). |

Индексы:

  * `idx_operator_account` (`operatorid`, `accountname`) (unique)
  * `idx_chatoperatoraccount_accountname` (`accountname`)
  * `idx_chatoperatoraccount_operatorid` (`operatorid`)

### `globalsettings` { #meta-globalsettings }

Глобальные настройки инсталляции.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `name` | `VARCHAR(50)` | NOT NULL | Имя настройки. |
| `value` | `LONGTEXT` | — | Значение. |

Индексы:

  * `idx_globalsettings_name` (`name`) (unique)

### `invoice` { #meta-invoice }

Счета на оплату. Служебная таблица, для hosted-клиентов не используется.

### `loginattempt` { #meta-loginattempt }

Попытки входа операторов. Сейчас в таблице хранятся неудачные попытки.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `email` | `VARCHAR(255)` | NOT NULL | Адрес электронной почты оператора. |
| `ip` | `VARCHAR(20)` | NOT NULL | IP-адрес устройства оператора. |
| `ts` | `BIGINT` | NOT NULL | Момент попытки (секунды). |
| `accountname` | `VARCHAR(64)` | — | Имя аккаунта. |
| `failed` | `BOOLEAN` | NOT NULL, DEFAULT '1' | Признак неудачной попытки входа. |

### `operatordevice` { #meta-operatordevice }

Устройства, с которых оператор работает в системе.

| Поле | Тип | Ограничения | Описание                                                                               |
| --- | --- | --- |----------------------------------------------------------------------------------------|
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор устройства оператора.                                                    |
| `deviceid` | `VARCHAR(64)` | NOT NULL | Идентификатор устройства для пользовательского интерфейса.                             |
| `accountname` | `VARCHAR(255)` | FK → `account.accountname`, NOT NULL, DEFAULT '' | Имя аккаунта.                                                                          |
| `operatorid` | `INT UNSIGNED` | FK → `chatoperator.operatorid`, NOT NULL | Идентификатор оператора.                                                               |
| `devicestatus` | `VARCHAR(18)` | NOT NULL | Статус оператора на устройстве (`online`, `offline`, `offline_processing` и другие).   |
| `useragent` | `VARCHAR(1023)` | — | Заголовок User-Agent устройства.                                                       |
| `pushtoken` | `VARCHAR(255)` | — | Push-токен (для мобильных устройств).                                                  |
| `pushservice` | `CHAR(255)` | — | Push-сервис (для мобильных устройств).                                                 |
| `dtmcreated` | `DATETIME_TIMESTAMPTZ` | — | Дата создания.                                                                         |
| `dtmmodified` | `DATETIME_TIMESTAMPTZ` | — | Дата последнего изменения.                                                             |
| `platform` | `VARCHAR(8)` | NOT NULL, DEFAULT 'ios' | Платформа (`web` / `ios` / `android`; значения `winphone`, `inf` и `pochta` устарели). |
| `pushbyemail` | `INT` | — | Флаг уведомления по почте (устарело).                                                  |
| `pushphone` | `DECIMAL(15, 0)` | — | Телефон для SMS (устарело).                                                            |
| `workhoursstatus` | `VARCHAR(16)` | — | Устарело.                                                                              |

Индексы:

  * `idx_operatordevice_dao` (`deviceid`, `accountname`, `operatorid`) (unique)
  * `idx_operatordevice_accountname` (`accountname`)

### `orderedservice` { #meta-orderedservice }

Заказы услуг (тарифные периоды).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `accountname` | `VARCHAR(255)` | FK → `account.accountname`, NOT NULL, DEFAULT '' | Имя аккаунта. |
| `dtmfrom` | `DATE` | NOT NULL | Дата начала оплаченного периода. |
| `dtmto` | `DATE` | NOT NULL | Дата окончания оплаченного периода. |
| `monthcnt` | `INT` | NOT NULL | Длительность заказа в месяцах. |
| `tariffkey` | `VARCHAR(32)` | — | Ключ тарифа. |
| `settings` | `LONGTEXT` | — | Настройки заказанной услуги (в том числе лицензионный ключ). |
| `description` | `LONGTEXT` | — | Описание. |
| `price` | `INT` | — | Стоимость заказа. |
| `invoiceguid` | `VARCHAR(256)` | — | Идентификатор связанного счёта. |
| `paymentmethod` | `VARCHAR(20)` | — | Способ оплаты. |
| `dtmcreated` | `DATETIME_TIMESTAMPTZ` | — | Дата создания заказа. |
| `status` | `VARCHAR(20)` | NOT NULL | Статус заказа (`payed`, `pending`, `payment_guaranteed`, `canceled` и другие). |
| `autoreorder` | `TINYINT` | — | Признак автопродления. |
| `comment` | `LONGTEXT` | — | Комментарий. |
| `replacedid` | `INT` | — | Идентификатор заказа, который заменяет эта запись. |
| `signature` | `LONGTEXT` | — | Подпись лицензионных данных заказа. |

Индексы:

  * `idx_orderedservice_accountname` (`accountname`)

### `organization` { #meta-organization }

Реквизиты организации-плательщика. Служебная таблица, для hosted-клиентов не используется.

### `promocode` { #meta-promocode }

Служебная таблица, для hosted-клиентов не используется.

### `recurringpaymentprofile` { #meta-recurringpaymentprofile }

Профили автоплатежей. Служебная таблица, для hosted-клиентов не используется.

### `service_user` { #meta-service-user }

Служебная таблица, для hosted-клиентов не используется.

### `support_user` { #meta-support-user }

Служебная таблица, для hosted-клиентов не используется.

### `tariff` { #meta-tariff }

Тарифы.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT UNSIGNED` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `tariffkey` | `VARCHAR(32)` | — | Ключ тарифа. |
| `accountname` | `VARCHAR(255)` | FK → `account.accountname` | Имя аккаунта. |
| `partner` | `VARCHAR(255)` | — | Имя партнёра. |
| `settings` | `LONGTEXT` | — | Настройки тарифа. |
| `descriptor` | `LONGTEXT` | — | Описание тарифа. |
| `comment` | `LONGTEXT` | — | Дополнительная информация. |

Индексы:

  * `idx_tariff_tariffkey` (`tariffkey`, `accountname`) (unique)

### `webim_pro_writeoff` { #meta-webim-pro-writeoff }

Служебная таблица, для hosted-клиентов не используется.


## Описание таблиц хранилища `pro` { #pro }

Имя на уровне СУБД: `webim_service_pro_<имя_аккаунта>`.

| Таблица                                                                       | Назначение                                                                                                                          |
|-------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------|
| [`abac_policy`](#pro-abac-policy)                                             | Элементы «Политика» дерева политик (ABAC).                                                                                          |
| [`abac_policy_mm_rule`](#pro-abac-policy-mm-rule)                             | Связи между политиками и правилами ABAC.                                                                                            |
| [`abac_policy_set`](#pro-abac-policy-set)                                     | Элементы «Группа политик» дерева политик (ABAC).                                                                                    |
| [`abac_policy_set_mm_policy`](#pro-abac-policy-set-mm-policy)                 | Связи между группами политик и политиками ABAC.                                                                                     |
| [`abac_policy_set_mm_policy_set`](#pro-abac-policy-set-mm-policy-set)         | Связи между группами политик ABAC.                                                                                                  |
| [`abac_rule`](#pro-abac-rule)                                                 | Элементы «Правило» дерева политик (ABAC).                                                                                           |
| [`account_category`](#pro-account-category)                                   | Общие для аккаунта категории диалогов.                                                                                              |
| [`actionlog`](#pro-actionlog)                                                 | История действий пользователей в системе и изменений системных настроек. Связь с оператором — поле `operatorid`.                    |
| [`api_auth_attempt`](#pro-api-auth-attempt)                                   | Неудачные попытки авторизации в API.                                                                                                |
| [`backgroundtask`](#pro-backgroundtask)                                       | Устарело, не используется.                                                                                                          |
| [`broadcast`](#pro-broadcast)                                                 | Рассылки.                                                                                                                           |
| [`broadcast_visitor`](#pro-broadcast-visitor)                                 | Связи между рассылками и посетителями.                                                                                              |
| [`category`](#pro-category)                                                   | Категории диалогов.                                                                                                                 |
| [`chatautoinvite`](#pro-chatautoinvite)                                       | Генератор лидов (автоприглашения).                                                                                                  |
| [`chatban`](#pro-chatban)                                                     | Блокировки посетителей в рамках аккаунта.                                                                                           |
| [`chatconfig`](#pro-chatconfig)                                               | Настройки аккаунта (account-config).                                                                                                |
| [`chatdepartment`](#pro-chatdepartment)                                       | Отделы.                                                                                                                             |
| [`chatdepartmentlocale`](#pro-chatdepartmentlocale)                           | Локализация названий отделов. Связь с отделом — поле `departmentid`.                                                                |
| [`chatmessage`](#pro-chatmessage)                                             | Сообщения диалога. Связь с чатом — поле `threadid`, с оператором — поле `operatorid`.                                               |
| [`chatonlineperiod`](#pro-chatonlineperiod)                                   | Периоды нахождения операторов в статусах. Связь с отделом — поле `departmentid`, с оператором — поле `operatorid`.                  |
| [`chatoperatordepartment`](#pro-chatoperatordepartment)                       | Привязки оператора к отделам и супервизорство в них.                                                                                |
| [`chatoperatorlastaccess`](#pro-chatoperatorlastaccess)                       | Последний доступ оператора и текущий статус. Связь с оператором — поле `operatorid`.                                                |
| [`chatrate`](#pro-chatrate)                                                   | Оценки операторов. Связь с чатом — поле `threadid`, с оператором — поле `operatorid`.                                               |
| [`chatstats`](#pro-chatstats)                                                 | Данные **Статистики 1.0**. Устарело, не используется.                                                                               |
| [`chatstatslog`](#pro-chatstatslog)                                           | Журнал обновления **Статистики 1.0**. Устарело, не используется.                                                                    |
| [`chatthread`](#pro-chatthread)                                               | Чаты (диалоги). Связь с оператором — поле `operatorid`, с сессией — поле `visitsessionid`.                                          |
| [`chatthreadhistory`](#pro-chatthreadhistory)                                 | История изменения чатов. Связь с чатом — поле `threadid`, с отделом — поле `departmentid`, с оператором — поле `operatorid`.        |
| [`chatvisitor`](#pro-chatvisitor)                                             | Посетители.                                                                                                                         |
| [`chatvisitordevice`](#pro-chatvisitordevice)                                 | Устройства посетителя.                                                                                                              |
| [`chatvisitsession`](#pro-chatvisitsession)                                   | Чат-сессии (`VisitSession`).                                                                                                        |
| [`dashboard_config`](#pro-dashboard-config)                                   | Конфигурация отчётов Панели приборов.                                                                                               |
| [`default_dashboard_config_override`](#pro-default-dashboard-config-override) | Статус (включён/отключён) стандартных отчётов Панели приборов.                                                                      |
| [`default_report_config_override`](#pro-default-report-config-override)       | Статус (включён/отключён) стандартных отчётов **Статистики**.                                                                       |
| [`default_report_group_override`](#pro-default-report-group-override)         | Статус (включена/отключена) стандартных групп отчётов.                                                                              |
| [`department_category`](#pro-department-category)                             | Категории, назначенные отделу.                                                                                                      |
| [`file`](#pro-file)                                                           | Метаданные файлов, загруженных в чат.                                                                                               |
| [`keyvalue`](#pro-keyvalue)                                                   | Универсальное key-value хранилище аккаунта (в том числе настройки интеграций).                                                      |
| [`location`](#pro-location)                                                   | Размещения (кнопки и окна чата).                                                                                                    |
| [`meta_visitor`](#pro-meta-visitor)                                           | Модель метапосетителя.                                                                                                              |
| [`meta_visitor_field`](#pro-meta-visitor-field)                               | Метаполя посетителя.                                                                                                                |
| [`operatorchatmessage`](#pro-operatorchatmessage)                             | Сообщения в чате операторов. Связь с оператором — поле `operatorid`.                                                                |
| [`operatorsupervisor`](#pro-operatorsupervisor)                               | Подревизные операторы. Связь с оператором — поля `supervisor_id` и `operator_id`.                                                   |
| [`private_keys`](#pro-private-keys)                                           | Приватные ключи аккаунта: подпись обработчиков событий чата и хеш provided visitor.                                                 |
| [`prompter`](#pro-prompter)                                                   | Суфлёры (prompters).                                                                                                                |
| [`report_config`](#pro-report-config)                                         | Конфигурации отчётов **Статистики v2**.                                                                                             |
| [`report_group`](#pro-report-group)                                           | Группы отчётов.                                                                                                                     |
| [`report_metric_config`](#pro-report-metric-config)                           | Конфигурации метрик конструктора аналитики.                                                                                         |
| [`resource`](#pro-resource)                                                   | Текстовые ресурсы системы (локализация интерфейса).                                                                                 |
| [`robot`](#pro-robot)                                                         | Боты и их настройки.                                                                                                                |
| [`role`](#pro-role)                                                           | Роли в системе **Webim** (администратор, супервизор, оператор и другие).                                                            |
| [`securitygroup`](#pro-securitygroup)                                         | Группы безопасности **Webim**: роли, отделы и наблюдаемые отделы. Используются, в том числе, при интеграции с **Active Directory**. |
| [`surveyanswer`](#pro-surveyanswer)                                           | Ответы посетителя на запущенный опрос.                                                                                              |
| [`surveyconfig`](#pro-surveyconfig)                                           | Метаинформация (конфигурация) опроса.                                                                                               |
| [`surveylaunch`](#pro-surveylaunch)                                           | Запущенные опросы.                                                                                                                  |
| [`thread_category`](#pro-thread-category)                                     | Категории, назначенные диалогу.                                                                                                     |
| [`visitor_routing_rule`](#pro-visitor-routing-rule)                           | Правила маршрутизации посетителей: поле посетителя, его значение и ключ размещения.                                                 |

Представление (view) в этой схеме: `chatthreadhistoryview`. Оно строится поверх таблиц и отдельно в перечне полей не описывается.

### `abac_policy` { #pro-abac-policy }

Элементы «Политика» дерева политик (ABAC).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `VARCHAR(100)` | PK, NOT NULL | Идентификатор записи. |
| `title` | `TEXT` | NOT NULL | Название. |
| `description` | `TEXT` | — | Описание. |
| `target` | `TEXT` | — | Назначение политики: выражения, по которым определяется применимость к запросу доступа. |
| `combining_algorithm` | `VARCHAR(50)` | NOT NULL | Алгоритм комбинирования вложенных правил (XACML). |
| `advices` | `TEXT` | — | Советы (Advice), возвращаемые вместе с решением. |
| `created` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Момент создания. |
| `updated` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Момент изменения. |
| `deleted` | `DATETIME_TIMESTAMPTZ` | — | Признак или момент удаления. |

### `abac_policy_mm_rule` { #pro-abac-policy-mm-rule }

Связи между политиками и правилами ABAC.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `policy_id` | `VARCHAR(100)` | FK → `abac_policy.id`, NOT NULL | Идентификатор политики. |
| `nested_rule_id` | `VARCHAR(100)` | FK → `abac_rule.id`, NOT NULL | Идентификатор вложенного правила. |
| `nested_order` | `INT UNSIGNED` | NOT NULL | Порядок правила внутри политики. |
| `is_active` | `BOOLEAN` | NOT NULL | Признак активности. |

Индексы:

  * `idx_abac_policy_mm_rule` (`policy_id`, `nested_rule_id`) (unique)

### `abac_policy_set` { #pro-abac-policy-set }

Элементы «Группа политик» дерева политик (ABAC).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `VARCHAR(100)` | PK, NOT NULL | Идентификатор записи. |
| `title` | `TEXT` | NOT NULL | Название. |
| `description` | `TEXT` | — | Описание. |
| `target` | `TEXT` | — | Назначение группы политик: выражения применимости к запросу доступа. |
| `combining_algorithm` | `VARCHAR(50)` | NOT NULL | Алгоритм комбинирования вложенных политик и групп (XACML). |
| `advices` | `TEXT` | — | Советы (Advice), возвращаемые вместе с решением. |
| `created` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Момент создания. |
| `updated` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Момент изменения. |
| `deleted` | `DATETIME_TIMESTAMPTZ` | — | Признак или момент удаления. |

### `abac_policy_set_mm_policy` { #pro-abac-policy-set-mm-policy }

Связи между группами политик и политиками ABAC.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `policy_set_id` | `VARCHAR(100)` | FK → `abac_policy_set.id`, NOT NULL | Идентификатор группы политик. |
| `nested_policy_id` | `VARCHAR(100)` | FK → `abac_policy.id`, NOT NULL | Идентификатор вложенной политики. |
| `nested_order` | `INT UNSIGNED` | NOT NULL | Порядок политики внутри группы. |
| `is_active` | `BOOLEAN` | NOT NULL | Признак активности. |

Индексы:

  * `idx_abac_policy_set_mm_policy` (`policy_set_id`, `nested_policy_id`) (unique)

### `abac_policy_set_mm_policy_set` { #pro-abac-policy-set-mm-policy-set }

Связи между группами политик ABAC.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `policy_set_id` | `VARCHAR(100)` | FK → `abac_policy_set.id`, NOT NULL | Идентификатор родительской группы политик. |
| `nested_policy_set_id` | `VARCHAR(100)` | FK → `abac_policy_set.id`, NOT NULL | Идентификатор вложенной группы политик. |
| `nested_order` | `INT UNSIGNED` | NOT NULL | Порядок вложенной группы. |
| `is_active` | `BOOLEAN` | NOT NULL | Признак активности. |

Индексы:

  * `idx_abac_policy_set_mm_policy_set` (`policy_set_id`, `nested_policy_set_id`) (unique)

### `abac_rule` { #pro-abac-rule }

Элементы «Правило» дерева политик (ABAC).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `VARCHAR(100)` | PK, NOT NULL | Идентификатор записи. |
| `title` | `TEXT` | NOT NULL | Название. |
| `target` | `TEXT` | — | Назначение правила: простые выражения применимости. |
| `condition` | `TEXT` | — | Дополнительные условия применимости правила. |
| `effect` | `ENUM('permit', 'deny')` | NOT NULL | Решение правила: разрешить (`permit`) или запретить (`deny`). |
| `advices` | `TEXT` | — | Советы (Advice), возвращаемые вместе с решением. |
| `created` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Момент создания. |
| `updated` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Момент изменения. |
| `deleted` | `DATETIME_TIMESTAMPTZ` | — | Признак или момент удаления. |

### `account_category` { #pro-account-category }

Общие для аккаунта категории диалогов.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `category_id` | `INT` | FK → `category.id`, NOT NULL | Идентификатор категории. |
| `order` | `INT` | NOT NULL | Порядок категории в списке аккаунта. |

Индексы:

  * `category_id_unique` (`category_id`, unique)

### `actionlog` { #pro-actionlog }

История действий пользователей в системе и изменений системных настроек. Связь с оператором — поле `operatorid`.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `dtm` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата действия. |
| `actiontarget` | `VARCHAR(255)` | NOT NULL | Цель действия. |
| `actiontype` | `ENUM('create', 'update', 'delete', 'login', 'logout', 'failed', 'reset')` | NOT NULL | Тип действия. |
| `operatorid` | `INT UNSIGNED` | — | Идентификатор оператора. |
| `operatorfullname` | `VARCHAR(255)` | — | Имя оператора. |
| `newvalue` | `JSON` | — | Новое значение. |
| `oldvalue` | `JSON` | — | Прежнее значение. |
| `ip` | `VARCHAR(15)` | — | IP-адрес устройства оператора. |
| `useragent` | `VARCHAR(255)` | — | Заголовок User-Agent браузера или мобильного приложения оператора. |
| `diff` | `JSON` | — | Разница между значениями. |
| `operatordeviceid` | `VARCHAR(64)` | — | Идентификатор сессии оператора (закодирован в `WEBIM_AUTH_TOKEN` в Base64 как `operator_id\|session_id`). |
| `actiontargetid` | `JSON` | — | Идентификатор объекта, над которым выполнено действие. |

### `api_auth_attempt` { #pro-api-auth-attempt }

Неудачные попытки авторизации в API.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `email` | `VARCHAR(255)` | NOT NULL | Адрес электронной почты. |
| `ip` | `VARCHAR(20)` | NOT NULL | IP-адрес. |
| `ts` | `BIGINT` | NOT NULL | Момент попытки. |

Индексы:

  * `idx_api_auth_attempt_ts` (`ts`)
  * `idx_api_auth_attempt_email` (`email`)
  * `idx_api_auth_attempt_ip` (`ip`)

### `backgroundtask` { #pro-backgroundtask }

Устаревшая функциональность; таблица не используется.

### `broadcast` { #pro-broadcast }

Рассылки.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `kind` | `VARCHAR(32)` | NOT NULL, DEFAULT 'history-chats' | Тип рассылки. По умолчанию `history-chats`. |
| `message` | `TEXT` | NOT NULL | Текст сообщения рассылки. |
| `data` | `LONGTEXT` | — | Дополнительные данные рассылки (получатели, фильтры). |
| `state` | `VARCHAR(32)` | NOT NULL | Состояние рассылки. |
| `operatorid` | `INT UNSIGNED` | — | Идентификатор оператора. |
| `recipientcount` | `INT UNSIGNED` | NOT NULL | Число получателей. |
| `completedcount` | `INT UNSIGNED` | NOT NULL | Число обработанных получателей. |
| `lastprocessedidx` | `INT UNSIGNED` | — | Индекс последнего обработанного получателя. |
| `ishidden` | `BOOLEAN` | NOT NULL, DEFAULT '1' | Признак скрытой рассылки. |
| `createdts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `modifiedts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |

### `broadcast_visitor` { #pro-broadcast-visitor }

Связи между рассылками и посетителями.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `external_visitor_id` | `VARCHAR(255)` | NOT NULL | Внешний идентификатор посетителя в канале. |
| `channel_id` | `VARCHAR(32)` | NOT NULL | Идентификатор канала общения. |
| `broadcast_id` | `INT` | FK → `broadcast.id`, NOT NULL | Идентификатор рассылки. |
| `ts` | `BIGINT` | NOT NULL | Момент привязки посетителя к рассылке (микросекунды). |

Индексы:

  * `idx_broadcast_visitor_external_visitor_id_channel_id` (`external_visitor_id`, `channel_id`) (unique)

### `category` { #pro-category }

Категории диалогов.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `parent_id` | `INT` | FK → `category.id` | Идентификатор родительской категории. Пустое значение — категория верхнего уровня. |
| `title` | `VARCHAR(128)` | NOT NULL | Название. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |

Индексы:

  * `idx_category_title` (`title`)
  * `idx_category_parent_id` (`parent_id`)
  * `idx_category_parent_id_title` (`parent_id`, `title`)

### `chatautoinvite` { #pro-chatautoinvite }

Генератор лидов (автоприглашения).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `autoinviteid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор приглашения. |
| `text` | `VARCHAR(255)` | NOT NULL | Текст приглашения. |
| `conditions` | `TEXT` | NOT NULL | Условия показа приглашения. |
| `name` | `VARCHAR(255)` | — | Название автоприглашения. |

### `chatban` { #pro-chatban }

Блокировки посетителей в рамках аккаунта.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `banid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `created` | `TIMESTAMPTZ` | NOT NULL, DEFAULT now() | Момент начала блокировки. |
| `till` | `TIMESTAMPTZ` | NOT NULL, DEFAULT '1970-01-02 00:00:00' (плейсхолдер) | Момент окончания блокировки. Значение при создании записи задаёт приложение, а не этот DEFAULT. |
| `address` | `VARCHAR(255)` | — | Заблокированный IP-адрес. |
| `email` | `VARCHAR(255)` | — | Заблокированный адрес электронной почты. |
| `phone` | `VARCHAR(255)` | — | Заблокированный телефон. |
| `channel_user_id` | `VARCHAR(255)` | — | Идентификатор пользователя в канале общения. |
| `channel_id` | `VARCHAR(255)` | — | Идентификатор канала общения. |
| `push_tokens` | `TEXT` | — | Push-токены заблокированного посетителя. |
| `comment` | `VARCHAR(255)` | — | Комментарий. |
| `blocked_count` | `INT` | DEFAULT '1' | Счётчик блокировок. |
| `json` | `LONGTEXT` | — | Дополнительные данные. |
| `excluded` | `TIMESTAMPTZ` | — | Момент снятия блокировки. |

Индексы:

  * `idx_chatban_till` (`till`)
  * `idx_chatban_address` (`address`)
  * `idx_chatban_email` (`email`)
  * `idx_chatban_phone` (`phone`)
  * `idx_chatban_channel` (`channel_user_id`, `channel_id`)
  * `idx_chatban_excluded` (`excluded`)

### `chatconfig` { #pro-chatconfig }

Настройки аккаунта (account-config).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `configid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор настройки. |
| `configkey` | `VARCHAR(255)` | NOT NULL | Имя настройки. |
| `configvalue` | `MEDIUMTEXT` | — | Значение настройки. |

Индексы:

  * `idx_chatconfig_configkey` (`configkey`) (unique)

### `chatdepartment` { #pro-chatdepartment }

Отделы.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `departmentid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор отдела. |
| `departmentkey` | `VARCHAR(255)` | — | Буквенный ключ отдела. |
| `departmentorder` | `INT` | DEFAULT '100' | Порядок сортировки. |
| `departmentgeo` | `VARCHAR(255)` | — | Географическая принадлежность. |
| `ishidden` | `BOOLEAN` | DEFAULT '0' | Признак скрытости отдела от посетителей. |
| `deleted` | `BOOLEAN` | DEFAULT '0' | Признак удаления. |
| `config` | `MEDIUMTEXT` | — | Настройки отдела. |

### `chatdepartmentlocale` { #pro-chatdepartmentlocale }

Локализация названий отделов. Связь с отделом — поле `departmentid`.

| Поле | Тип | Ограничения | Описание                   |
| --- | --- | --- |----------------------------|
| `departmentlocaleid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи.      |
| `departmentid` | `INT` | NOT NULL | Идентификатор отдела.      |
| `locale` | `CHAR(2)` | NOT NULL | Код языка.                 |
| `departmentname` | `VARCHAR(256)` | NOT NULL | Название отдела.           |
| `answers` | `TEXT` | — | Устарело, не используется. |

Индексы:

  * `idx_chatdepartmentlocale_departmentid_locale` (`departmentid`, `locale`) (unique)

### `chatmessage` { #pro-chatmessage }

Сообщения диалога. Связь с чатом — поле `threadid`, с оператором — поле `operatorid`.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `messageid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор сообщения. |
| `threadid` | `INT` | NOT NULL | Идентификатор чата. |
| `kind` | `INT` | NOT NULL | Тип сообщения (см. перечень ниже). |
| `operatorid` | `INT UNSIGNED` | — | Идентификатор оператора. |
| `message` | `TEXT` | NOT NULL | Текст сообщения. |
| `created` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата создания. |
| `sendername` | `VARCHAR(64)` | — | Имя отправителя. |
| `json` | `TEXT` | — | Дополнительные данные. |
| `createdts` | `BIGINT` | — | Момент создания в приложении (микросекунды). |
| `insertedts` | `BIGINT` | — | Момент записи в базу (микросекунды). |
| `modifiedts` | `BIGINT` | — | Момент последнего изменения в приложении (микросекунды). |
| `updatedts` | `BIGINT` | — | Момент последнего обновления в базе (микросекунды). |
| `channelsideid` | `VARCHAR(255)` | — | Идентификатор сообщения на стороне канала общения. |
| `guid` | `VARCHAR(40)` | — | Глобальный идентификатор сообщения. |
| `clientsideid` | `VARCHAR(40)` | — | Идентификатор сообщения на стороне клиента (виджет, SDK). |

Индексы:

  * `idx_chatmessage_operatorid` (`operatorid`)
  * `idx_chatmessage_threadid` (`threadid`)
  * `idx_chatmessage_created` (`created`)
  * `idx_chatmessage_insertedts` (`insertedts`)
  * `idx_chatmessage_guid` (`guid`)
  * `idx_chatmessage_channelsideid` (`channelsideid`)
  * `idx_chatmessage_sendername` (`sendername`) (GIN (PostgreSQL))

Значения поля `kind`:

  * `1` — `visitor`, сообщение посетителя;

  * `2` — `operator`, сообщение оператора;

  * `3` — `for_operator`, видно только оператору;

  * `4` — `info`, системное;

  * `9` — `operator_busy`, о занятости оператора;

  * `10` — `cont_req`, запрос контактов;

  * `11` — `contacts`, контакты;

  * `13` — `file_operator`, файл от оператора;

  * `14` — `file_visitor`, файл от посетителя;

  * `15` — `form_response`, данные формы (например, при интеграции с Zendesk);

  * `16` — `operator_note`, заметка оператора;

  * `17` — `keyboard`, набор кнопок;

  * `18` — `keyboard_response`, выбранная посетителем кнопка;

  * `19` — `apple_chat`, специализированное сообщение **Apple Business Chat**;

  * `20` — `apple_chat_response`, ответ посетителя в **Apple Business Chat**.

### `chatonlineperiod` { #pro-chatonlineperiod }

Периоды нахождения операторов в статусах. Связь с отделом — поле `departmentid`, с оператором — поле `operatorid`.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT UNSIGNED` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `operatorid` | `INT UNSIGNED` | NOT NULL | Идентификатор оператора. |
| `departmentid` | `INT` | — | Идентификатор отдела. |
| `locale` | `CHAR(2)` | — | Локализация. |
| `dtmfrom` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Начало периода. |
| `dtmto` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Окончание периода. |
| `status` | `VARCHAR(20)` | DEFAULT 'online' | Статус оператора. |

Индексы:

  * `idx_chatonlineperiod_period` (`dtmfrom`, `dtmto`)
  * `idx_chatonlineperiod_departmentid` (`departmentid`)
  * `idx_chatonlineperiod_operatorid` (`operatorid`)
  * `idx_chatonlineperiod_locale` (`locale`)
  * `idx_chatonlineperiod_dtmfrom` (`dtmfrom`)
  * `idx_chatonlineperiod_dtmto` (`dtmto`)

### `chatoperatordepartment` { #pro-chatoperatordepartment }

Привязки оператора к отделам и супервизорство в них.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `operatordepartmentid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `operatorid` | `INT UNSIGNED` | NOT NULL | Идентификатор оператора. |
| `departmentid` | `INT` | NOT NULL | Идентификатор отдела. |
| `priority` | `INT` | — | Приоритет (по умолчанию 5). |
| `supervisor` | `BOOLEAN` | DEFAULT '0' | Признак супервизорства в отделе. |

Индексы:

  * `idx_chatoperatordepartment_operatorid_departmentid` (`operatorid`, `departmentid`) (unique)

### `chatoperatorlastaccess` { #pro-chatoperatorlastaccess }

Последний доступ оператора и текущий статус. Связь с оператором — поле `operatorid`.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `operatorid` | `INT UNSIGNED` | PK, NOT NULL | Идентификатор оператора. |
| `lastvisited` | `TIMESTAMPTZ` | NOT NULL, DEFAULT now() | Момент последнего обращения оператора. |
| `status` | `INT` | NOT NULL, DEFAULT '0' | Текущий статус оператора. |
| `locales` | `VARCHAR(255)` | — | Языки, которые обслуживает оператор. |

### `chatrate` { #pro-chatrate }

Оценки операторов. Связь с чатом — поле `threadid`, с оператором — поле `operatorid`.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `rateid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `operatorid` | `INT UNSIGNED` | — | Идентификатор оператора. |
| `departmentid` | `INT UNSIGNED` | — | Идентификатор отдела. |
| `threadid` | `INT` | NOT NULL | Идентификатор чата, в котором поставлена оценка. |
| `rate` | `INT` | NOT NULL | Значение оценки. |
| `date` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата оценки. |
| `deldate` | `DATE` | — | Дата удаления оценки. |

Индексы:

  * `idx_chatrate_operatorid_threadid` (`operatorid`, `threadid`) (unique)
  * `idx_chatrate_threadid` (`threadid`)

### `chatstats` { #pro-chatstats }

Основные данные **Статистики 1.0**.

Устаревшая таблица **Статистики 1.0**. Для **Статистики v2** и Панели приборов v2 данные пишутся в **ClickHouse**.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT UNSIGNED` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `dtm` | `DATE` | NOT NULL | Дата. |
| `param_name` | `VARCHAR(64)` | NOT NULL, DEFAULT '' | Метрика. |
| `param_value` | `DECIMAL(20, 2)` | NOT NULL | Значение. |
| `hr` | `INT` | — | Час. |
| `offline` | `BOOLEAN` | — | Признак офлайн-диалога. |
| `operatorid` | `INT UNSIGNED` | — | Идентификатор оператора. |
| `is_complete` | `BOOLEAN` | DEFAULT '1' | Признак завершённости. |
| `category` | `VARCHAR(255)` | — | Категория диалога. |
| `subcategory` | `VARCHAR(255)` | — | Подкатегория диалога. |
| `departmentid` | `INT` | — | Идентификатор отдела. |
| `locale` | `CHAR(2)` | — | Язык диалога. |
| `officeid` | `INT` | — | Идентификатор офиса (поле к удалению). |
| `category_filter` | `VARCHAR(255)` | — | Фильтр по категории. |
| `subcategory_filter` | `VARCHAR(255)` | — | Фильтр по подкатегории. |
| `departmentid_data` | `INT` | — | Идентификатор отдела в данных статистики. |
| `country` | `VARCHAR(128)` | — | Страна посетителя. |
| `region` | `TINYTEXT` | — | Регион посетителя. |
| `city` | `TINYTEXT` | — | Город посетителя. |
| `officeid_data` | `INT` | — | Данные идентификатора офиса (поле к удалению). |
| `startpage` | `TINYTEXT` | — | Адрес страницы, с которой начался диалог. |
| `query` | `TEXT` | DEFAULT None | Служебный запрос пересчёта. |
| `threadids` | `TEXT` | — | Идентификаторы чатов, попавших в агрегат. |
| `logid` | `INT` | — | Ссылка на запись в `chatstatslog`. |

Индексы:

  * `idx_chatstats_param_name_dtm_hr_operatorid` (`param_name`, `dtm`, `hr`, `operatorid`)
  * `idx_chatstats_is_complete` (`is_complete`)
  * `idx_chatstats_dtm` (`dtm`)

### `chatstatslog` { #pro-chatstatslog }

Журнал обновления **Статистики 1.0**.

Устаревшая таблица. Для **Статистики v2** и Панели приборов v2 данные пишутся в **ClickHouse**.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `query` | `TEXT` | NOT NULL | Текст запроса пересчёта статистики. |
| `dtm` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Момент выполнения пересчёта. |

### `chatthread` { #pro-chatthread }

Чаты (диалоги). Связь с оператором — поле `operatorid`, с сессией — поле `visitsessionid`.

| Поле | Тип | Ограничения | Описание                                                 |
| --- | --- | --- |----------------------------------------------------------|
| `threadid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор чата.                                      |
| `operatorfullname` | `VARCHAR(64)` | — | Имя назначенного оператора.                              |
| `operatorid` | `INT UNSIGNED` | — | Идентификатор назначенного оператора.                    |
| `created` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата создания.                                           |
| `modified` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата изменения.                                          |
| `revision` | `INT` | — | Устарело.                                                |
| `state` | `VARCHAR(128)` | NOT NULL | Состояние чата (см. перечень ниже).                      |
| `token` | `INT` | NOT NULL | Устарело.                                                |
| `nextoperatorid` | `INT UNSIGNED` | — | Устарело.                                                |
| `locale` | `CHAR(2)` | — | Язык диалога.                                            |
| `lastpingvisitor` | `TIMESTAMPTZ` | DEFAULT '1970-01-02 00:00:00' (плейсхолдер) | Устарело.                                                |
| `lastpingagent` | `TIMESTAMPTZ` | DEFAULT '1970-01-02 00:00:00' (плейсхолдер) | Устарело.                                                |
| `visitortyping` | `BOOLEAN` | DEFAULT '0' | Устарело.                                                |
| `agenttyping` | `BOOLEAN` | DEFAULT '0' | Устарело.                                                |
| `shownmessageid` | `INT` | — | Устарело.                                                |
| `visitormessagecount` | `INT` | NOT NULL, DEFAULT '0' | Количество сообщений посетителя.                         |
| `visitsessionid` | `VARCHAR(40)` | NOT NULL | Идентификатор сессии.                                    |
| `departmentid` | `INT` | — | Устарело.                                                |
| `offline` | `BOOLEAN` | NOT NULL, DEFAULT '0' | Признак офлайн-диалога.                                  |
| `category` | `VARCHAR(128)` | — | Категория (историческое поле).                           |
| `subcategory` | `VARCHAR(128)` | — | Подкатегория (историческое поле).                        |
| `threadkind` | `ENUMSET('undefined', 'could not define', 'skip', 'missed', 'chat', 'bounce', 'rejected_invitation', 'offline')` | — | Тип чата.                                                |
| `json` | `TEXT` | — | Дополнительные данные.                                   |
| `officeid` | `INT UNSIGNED` | — | Идентификатор офиса (поле к удалению).                   |
| `manuallyassignedoperatorid` | `INT UNSIGNED` | — | ИД вручную присвоенного оператора.                       |
| `startpage` | `TEXT` | — | URL страницы, с которой начался чат.                     |
| `createdts` | `BIGINT` | — | Момент создания в приложении (микросекунды).             |
| `modifiedts` | `BIGINT` | — | Момент последнего изменения в приложении (микросекунды). |
| `insertedts` | `BIGINT` | — | Момент записи в базу (микросекунды).                     |
| `updatedts` | `BIGINT` | — | Момент последнего обновления в базе (микросекунды).      |
| `visitorid` | `VARCHAR(255)` | — | Идентификатор посетителя.                                |

Индексы:

  * `idx_chatthread_visitsessionid` (`visitsessionid`)
  * `idx_chatthread_state` (`state`)
  * `idx_chatthread_threadkind` (`threadkind`) (GIN (PostgreSQL))
  * `idx_chatthread_created` (`created`)
  * `idx_chatthread_updatedts` (`updatedts`)
  * `idx_chatthread_visitorid_threadid` (`visitorid`, `threadid`)
  * `idx_chatthread_createdts` (`createdts`)
  * `idx_chatthread_operatorfullname` (`operatorfullname`) (GIN (PostgreSQL))

Актуальные значения поля `state` в версии **Webim 10.8**:

  * `routing` — направляется маршрутизатором;

  * `queue` — в очереди;

  * `chatting` — в чате с оператором;

  * `chatting_with_robot` — в чате с ботом;

  * `hold` — на удержании;

  * `closed` — закрыт;

  * `closed_by_operator` — закрыт оператором;

  * `invitation` — посетитель приглашён;

  * `deleted` — удалён.

В исторических записях `chatthread.state` у незакрытых чатов могут встречаться и более ранние значения: `offline_queue`, `offline_process`, а в `chatthreadhistory` - те же два ранних значения плюс `closed_by_visitor`.

### `chatthreadhistory` { #pro-chatthreadhistory }

История изменения чатов. Связь с чатом — поле `threadid`, с отделом — поле `departmentid`, с оператором — поле `operatorid`.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `threadhistoryid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `threadid` | `INT` | NOT NULL | Идентификатор чата. |
| `number` | `INT` | NOT NULL | Порядковый номер изменения чата. |
| `dtm` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата изменения. |
| `state` | `VARCHAR(128)` | NOT NULL | Состояние, в которое перешёл чат (см. перечень ниже). |
| `operatorid` | `INT UNSIGNED` | — | Идентификатор оператора на момент изменения. |
| `departmentid` | `INT` | — | Отдел на момент изменения. |
| `event` | `VARCHAR(128)` | — | Событие, повлекшее изменение. |
| `locale` | `CHAR(2)` | DEFAULT 'ru' | Локализация. |
| `officeid` | `INT UNSIGNED` | — | Идентификатор офиса (поле к удалению). |
| `ts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |

Индексы:

  * `idx_chatthreadhistory_dtm` (`dtm`)
  * `idx_chatthreadhistory_threadid` (`threadid`)
  * `idx_chatthreadhistory_threadid_number` (`threadid`, `number`)
  * `idx_chatthreadhistory_threadid_operatorid` (`threadid`, `operatorid`)
  * `idx_chatthreadhistory_ts` (`ts`)

Актуальные значения поля `state` в версии **10.8**:

  * `routing` — направляется маршрутизатором;

  * `queue` — в очереди;

  * `chatting` — в чате с оператором;

  * `chatting_with_robot` — в чате с ботом;

  * `hold` — на удержании;

  * `closed` — закрыт окончательно;

  * `closed_by_operator` — закрыт оператором;

  * `invitation` — посетителю отображается автоприглашение;

  * `deleted` — удалён.

В исторических записях `chatthreadhistory` могут встречаться и более ранние значения (`offline_queue`, `offline_process`, `closed_by_visitor`).

### `chatvisitor` { #pro-chatvisitor }

Посетители.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `visitorid` | `VARCHAR(255)` | NOT NULL | Идентификатор посетителя. |
| `providedid` | `VARCHAR(255)` | — | Идентификатор посетителя в системе заказчика. |
| `name` | `VARCHAR(255)` | — | Имя. |
| `email` | `VARCHAR(255)` | — | Адрес электронной почты. |
| `phone` | `VARCHAR(128)` | — | Телефон. |
| `channelid` | `VARCHAR(128)` | — | Идентификатор канала общения. |
| `channeltype` | `VARCHAR(128)` | — | Тип канала общения. |
| `createdts` | `BIGINT` | — | Момент создания в приложении (микросекунды). |
| `modifiedts` | `BIGINT` | — | Момент последнего изменения (микросекунды). |
| `json` | `TEXT` | — | Дополнительные данные. |
| `metavisitorid` | `VARCHAR(36)` | — | Идентификатор модели метапосетителя. |

Индексы:

  * `idx_chatvisitor_visitorid` (`visitorid`) (unique)
  * `idx_chatvisitor_providedid` (`providedid`)
  * `idx_chatvisitor_metavisitorid` (`metavisitorid`)
  * `idx_chatvisitor_email` (`email`)
  * `idx_chatvisitor_phone` (`phone`)
  * `idx_chatvisitor_channel_id` (`channelid`)

### `chatvisitordevice` { #pro-chatvisitordevice }

Устройства посетителя.

| Поле | Тип | Ограничения | Описание                                                                                           |
| --- | --- | --- |----------------------------------------------------------------------------------------------------|
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи.                                                                              |
| `visitorid` | `VARCHAR(255)` | NOT NULL | Идентификатор посетителя.                                                                          |
| `deviceid` | `VARCHAR(255)` | — | Идентификатор устройства посетителя.                                                               |
| `platform` | `VARCHAR(128)` | — | Платформа устройства (`web` / `ios` / `android` / `winphone`; значения `inf` и `pochta` устарели). |
| `pushservice` | `VARCHAR(255)` | — | Push-сервис.                                                                                       |
| `pushtoken` | `VARCHAR(255)` | — | Push-токен (для мобильных устройств).                                                              |
| `useragent` | `VARCHAR(512)` | — | Приложение клиента (User Agent).                                                                   |
| `createdts` | `BIGINT` | — | Момент создания (микросекунды).                                                                    |
| `modifiedts` | `BIGINT` | — | Момент изменения (микросекунды).                                                                   |
| `deleted` | `BOOLEAN` | NOT NULL, DEFAULT '0' | Признак удаления.                                                                                  |
| `json` | `TEXT` | — | Дополнительные данные.                                                                             |

Индексы:

  * `idx_chatvisitordevice_visitorid` (`visitorid`)
  * `idx_chatvisitordevice_deviceid` (`deviceid`)
  * `idx_chatvisitordevice_pushtoken_and_pushservice` (`pushtoken`, `pushservice`)

### `chatvisitsession` { #pro-chatvisitsession }

Чат-сессии (`VisitSession`).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор чат-сессии. |
| `visitsessionid` | `VARCHAR(40)` | NOT NULL | Идентификатор сессии для интерфейса. |
| `ip` | `VARCHAR(20)` | — | IP-адрес клиента. |
| `remotehost` | `VARCHAR(255)` | — | Устарело. |
| `useragent` | `VARCHAR(512)` | — | Заголовок User-Agent. |
| `userid` | `VARCHAR(64)` | — | Устарело. |
| `visitorid` | `VARCHAR(255)` | NOT NULL | Внутренний идентификатор клиента. |
| `visitorname` | `VARCHAR(255)` | — | Имя посетителя. |
| `created` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата создания. |
| `updated` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата последнего изменения. |
| `partnerref` | `VARCHAR(255)` | — | Устарело. |
| `bitrixsessionid` | `VARCHAR(255)` | — | Устарело. |
| `hasthread` | `BOOLEAN` | NOT NULL, DEFAULT '0' | Устарело. |
| `invitationstate` | `VARCHAR(32)` | — | Устарело. |
| `invitationid` | `INT` | — | Устарело. |
| `json` | `TEXT` | — | Дополнительные данные. |
| `country` | `VARCHAR(128)` | — | Страна. |
| `region` | `TINYTEXT` | — | Регион. |
| `city` | `TINYTEXT` | — | Город. |

Индексы:

  * `idx_chatvisitsession_visitsessionid` (`visitsessionid`) (unique)
  * `idx_chatvisitsession_visitorid` (`visitorid`)
  * `idx_chatvisitsession_updated` (`updated`)
  * `idx_chatvisitsession_hasthread` (`hasthread`)
  * `idx_chatvisitsession_ip` (`ip`)

### `dashboard_config` { #pro-dashboard-config }

Конфигурация отчётов Панели приборов v2.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `title` | `JSON` | NOT NULL | Название. |
| `description` | `JSON` | — | Описание. |
| `report_config_id` | `VARCHAR(100)` | NOT NULL | Идентификатор конфигурации отчёта, который показывает карточка Панели приборов. |
| `refresh_interval` | `INT UNSIGNED` | — | Интервал автообновления карточки (секунды). |
| `default_filters` | `JSON` | NOT NULL | Фильтры карточки по умолчанию. |
| `roles` | `JSON` | — | Роли. |
| `owner_id` | `INT UNSIGNED` | — | Идентификатор владельца. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `updated_ts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |
| `deleted_ts` | `BIGINT` | — | Момент удаления (микросекунды). |
| `is_disabled` | `BOOLEAN` | NOT NULL | Признак отключения. |

### `default_dashboard_config_override` { #pro-default-dashboard-config-override }

Статус (включён/отключён) отчётов Панели приборов по умолчанию.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `VARCHAR(255)` | PK, NOT NULL | Идентификатор записи. |
| `is_disabled` | `BOOLEAN` | NOT NULL | Признак отключения. |

### `default_report_config_override` { #pro-default-report-config-override }

Статус (включён/отключён) отчётов **Статистики** по умолчанию.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `VARCHAR(255)` | PK, NOT NULL | Идентификатор записи. |
| `is_disabled` | `BOOLEAN` | NOT NULL | Признак отключения. |

### `default_report_group_override` { #pro-default-report-group-override }

Статус (включена/отключена) групп отчётов по умолчанию.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `VARCHAR(255)` | PK, NOT NULL | Идентификатор записи. |
| `is_disabled` | `BOOLEAN` | NOT NULL | Признак отключения. |

### `department_category` { #pro-department-category }

Категории, назначенные отделу.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `department_id` | `INT` | FK → `chatdepartment.departmentid`, NOT NULL | Идентификатор отдела. |
| `category_id` | `INT` | FK → `category.id`, NOT NULL | Идентификатор категории. |
| `order` | `INT` | NOT NULL | Порядок категории в списке отдела. |

Индексы:

  * `idx_department_category_department_id` (`department_id`)
  * `category_id_dep_id_unique` (`department_id`, `category_id`, unique)

### `file` { #pro-file }

Метаданные файлов, загруженных в чат.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT UNSIGNED` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `guid` | `VARCHAR(50)` | — | Глобальный идентификатор файла. |
| `filename` | `VARCHAR(255)` | — | Имя файла. |
| `descriptor` | `JSON` | — | Метаданные файла. |
| `subfolder` | `VARCHAR(255)` | — | Подкаталог в файловом хранилище. |
| `created_ts` | `BIGINT` | — | Момент создания (микросекунды). |

Индексы:

  * `idx_file_guid` (`guid`)

### `keyvalue` { #pro-keyvalue }

Универсальное key-value хранилище аккаунта (в том числе настройки интеграций).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `key` | `VARCHAR(45)` | NOT NULL | Ключ. |
| `value` | `TEXT` | — | Значение. |
| `modifiedts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |

Индексы:

  * `idx_keyvalue_key` (`key`) (unique)

### `location` { #pro-location }

Размещения (кнопки и окна чата).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `VARCHAR(36)` | PK, NOT NULL | Идентификатор размещения. |
| `key` | `VARCHAR(64)` | NOT NULL | Ключ размещения. |
| `title` | `JSON` | NOT NULL | Название. |
| `button` | `JSON` | NOT NULL | Настройки кнопки чата. |
| `chat` | `JSON` | NOT NULL | Настройки окна чата. |
| `invitation` | `JSON` | NOT NULL | Настройки автоприглашения. |
| `styles` | `JSON` | NOT NULL | Стили размещения. |
| `misc` | `JSON` | NOT NULL | Прочие настройки размещения. |
| `resources` | `JSON` | — | Текстовые ресурсы размещения. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `updated_ts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |
| `deleted_ts` | `BIGINT` | — | Момент удаления (микросекунды). |

### `meta_visitor` { #pro-meta-visitor }

Модель метапосетителя.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `meta_visitor_id` | `VARCHAR(36)` | NOT NULL | Идентификатор метапосетителя. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `modified_ts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |

Индексы:

  * `idx_meta_visitor_meta_visitor_id` (`meta_visitor_id`) (unique)

### `meta_visitor_field` { #pro-meta-visitor-field }

Метаполя посетителя.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `field_id` | `VARCHAR(36)` | NOT NULL | Идентификатор поля. |
| `name` | `VARCHAR(32)` | NOT NULL | Имя поля посетителя. |
| `value` | `VARCHAR(64)` | NOT NULL | Значение поля. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `meta_visitor_id` | `VARCHAR(36)` | FK → `meta_visitor.meta_visitor_id`, NOT NULL | Идентификатор метапосетителя. |

Индексы:

  * `idx_meta_visitor_field_field_id` (`field_id`) (unique)
  * `idx_meta_visitor_field_name_value` (`name`, `value`) (unique)

### `operatorchatmessage` { #pro-operatorchatmessage }

Сообщения в чате операторов. Связь с оператором — поле `operatorid`.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `messageid` | `INT` | PK, NOT NULL, autoincrement | Идентификатор сообщения. |
| `messageuid` | `VARCHAR(40)` | NOT NULL | Идентификатор для РМО. |
| `operatorchatid` | `INT` | NOT NULL | Идентификатор чата операторов. |
| `kind` | `VARCHAR(64)` | NOT NULL | Тип сообщения. |
| `operatorid` | `INT UNSIGNED` | — | Идентификатор автора сообщения. |
| `sendername` | `VARCHAR(64)` | — | Имя автора сообщения. |
| `message` | `TEXT` | NOT NULL | Текст. |
| `created` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Дата создания. |
| `json` | `TEXT` | — | Дополнительные данные. |

Индексы:

  * `idx_operatorchatmessage_operatorid` (`operatorid`)
  * `idx_operatorchatmessage_operatorchatid` (`operatorchatid`)
  * `idx_operatorchatmessage_messageuid` (`messageuid`)

### `operatorsupervisor` { #pro-operatorsupervisor }

Подревизные операторы. Связь с оператором — поля `supervisor_id` и `operator_id`.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT UNSIGNED` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `operator_id` | `INT UNSIGNED` | NOT NULL | Идентификатор подревизного оператора. |
| `supervisor_id` | `INT UNSIGNED` | NOT NULL | Идентификатор оператора-ревизора. |

Индексы:

  * `idx_operatorsupervisor_supervisorid` (`supervisor_id`)

### `private_keys` { #pro-private-keys }

Приватные ключи аккаунта: подпись обработчиков событий чата и данных посетителей из авторизованной зоны.

С версии **10.8** ключи хранятся в этой таблице, а не в `chatconfig`.

| Поле | Тип | Ограничения | Описание                                       |
| --- | --- | --- |------------------------------------------------|
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи.                          |
| `name` | `VARCHAR(255)` | — | Отображаемое имя ключа.                        |
| `type` | `ENUM('chat_event_handlers_signature', 'provided_visitor_hash')` | NOT NULL | Назначение ключа.                              |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды).                |
| `expires_ts` | `BIGINT` | NOT NULL | Срок действия.                                 |
| `private_key` | `VARCHAR(255)` | NOT NULL | Значение ключа. Хранится в зашифрованном виде, если настроено шифрование (`encryption` в `main.json`). |
| `operator_id` | `INT UNSIGNED` | — | Идентификатор оператора, создавшего ключ.      |
| `last_used_ts` | `BIGINT` | — | Момент последнего использования.               |
| `deleted` | `BOOLEAN` | NOT NULL, DEFAULT '0' | Признак удаления.                              |

### `prompter` { #pro-prompter }

Суфлёры (prompters).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `name` | `JSON` | NOT NULL | Название суфлёра. |
| `type` | `VARCHAR(32)` | NOT NULL | Тип суфлёра. |
| `data` | `LONGTEXT` | NOT NULL | Настройки суфлёра. |
| `deleted` | `BOOLEAN` | NOT NULL, DEFAULT '0' | Признак или момент удаления. |
| `is_disabled` | `BOOLEAN` | NOT NULL, DEFAULT '0' | Признак отключения. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `modified_ts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |

### `report_config` { #pro-report-config }

Конфигурации отчётов **Статистики v2**.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `title` | `JSON` | NOT NULL | Название. |
| `description` | `JSON` | — | Описание. |
| `fields` | `JSON` | NOT NULL | Описание колонок и настроек отчёта. |
| `owner_id` | `INT UNSIGNED` | — | Идентификатор владельца. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `updated_ts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |
| `deleted_ts` | `BIGINT` | — | Момент удаления (микросекунды). |
| `is_disabled` | `BOOLEAN` | NOT NULL | Признак отключения. |

### `report_group` { #pro-report-group }

Группы отчётов.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `title` | `JSON` | NOT NULL | Название. |
| `description` | `JSON` | — | Описание. |
| `report_configs` | `JSON` | NOT NULL | Список идентификаторов отчётов, входящих в группу. |
| `owner_id` | `INT UNSIGNED` | — | Идентификатор владельца. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `updated_ts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |
| `deleted_ts` | `BIGINT` | — | Момент удаления (микросекунды). |
| `is_disabled` | `BOOLEAN` | NOT NULL | Признак отключения. |

### `report_metric_config` { #pro-report-metric-config }

Конфигурации метрик конструктора аналитики.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `title` | `JSON` | NOT NULL | Название. |
| `description` | `JSON` | — | Описание. |
| `source_id` | `VARCHAR(100)` | NOT NULL | Идентификатор источника данных метрики. |
| `expression` | `TEXT` | NOT NULL | SQL-выражение метрики. |
| `owner_id` | `INT UNSIGNED` | — | Идентификатор владельца. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `updated_ts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |
| `deleted_ts` | `BIGINT` | — | Момент удаления (микросекунды). |
| `variables` | `JSON` | — | Переменные выражения. |
| `common_filters` | `JSON` | NOT NULL | Общие фильтры метрики. |

### `resource` { #pro-resource }

Текстовые ресурсы системы (локализация интерфейса), переопределённые в редакторе ресурсов. Если ресурсы не переопределялись, таблица пуста. Исходные ресурсы хранятся в файлах сборки.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `lang` | `VARCHAR(2)` | NOT NULL | Язык. |
| `key` | `VARCHAR(255)` | NOT NULL | Ключ ресурса. |
| `value` | `TEXT` | NOT NULL | Значение. |
| `createdts` | `BIGINT` | NOT NULL | Момент создания. |
| `updatedts` | `BIGINT` | NOT NULL | Момент обновления. |

Индексы:

  * `idx_resource_lang_key` (`lang`, `key`) (unique)

### `robot` { #pro-robot }

Боты и их настройки.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `type` | `VARCHAR(32)` | NOT NULL | Тип бота. |
| `data` | `LONGTEXT` | — | Данные для обработки ботом. |
| `order` | `INT` | NOT NULL, DEFAULT '100' | Порядок распределения чатов по ботам. |
| `status` | `VARCHAR(32)` | NOT NULL | Статус бота. |
| `deleted` | `BOOLEAN` | NOT NULL, DEFAULT '0' | Признак удаления. |
| `operatorid` | `INT UNSIGNED` | NOT NULL | Идентификатор оператора-бота. |
| `version` | `INT` | NOT NULL, DEFAULT '1' | Версия конфигурации бота. |

### `role` { #pro-role }

Роли в системе **Webim** (администратор, супервизор, оператор и другие).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `VARCHAR(36)` | PK, NOT NULL | Идентификатор записи. |
| `key` | `VARCHAR(64)` | NOT NULL | Ключ роли. |
| `title` | `JSON` | NOT NULL | Название роли. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `updated_ts` | `BIGINT` | NOT NULL | Момент изменения (микросекунды). |
| `deleted_ts` | `BIGINT` | — | Момент удаления (микросекунды). |

### `securitygroup` { #pro-securitygroup }

Группы безопасности **Webim**: роли, отделы и наблюдаемые отделы. Используются при интеграции с **Active Directory** SSO (LDAP).

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `name` | `VARCHAR(256)` | NOT NULL, unique | Имя группы безопасности. |
| `departments_ids` | `JSON` | — | Идентификаторы отделов. |
| `roles` | `JSON` | NOT NULL | Роли группы. |
| `supervised_department_ids` | `JSON` | — | Идентификаторы наблюдаемых отделов. |
| `created_ts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |
| `updated_ts` | `BIGINT` | — | Момент изменения (микросекунды). |

### `surveyanswer` { #pro-surveyanswer }

Ответы посетителя на запущенный опрос.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `surveylaunchid` | `VARCHAR(32)` | FK → `surveylaunch.surveylaunchid`, NOT NULL | Идентификатор запущенного опроса. |
| `formid` | `INT` | NOT NULL | Идентификатор формы опроса. |
| `questionid` | `INT` | NOT NULL | Идентификатор вопроса. |
| `type` | `VARCHAR(128)` | NOT NULL | Вид вопроса. |
| `question` | `TEXT` | NOT NULL | Текст вопроса. |
| `answer` | `LONGTEXT` | NOT NULL | Ответ посетителя. |
| `createdts` | `BIGINT` | NOT NULL | Момент создания (микросекунды). |

Индексы:

  * `idx_surveyanswer_threadid_surveylaunchid_section_number` (`surveylaunchid`, `formid`, `questionid`) (unique)

### `surveyconfig` { #pro-surveyconfig }

Настройки (конфигурация) опроса.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `title` | `JSON` | NOT NULL | Название. |
| `descriptor` | `JSON` | — | Описание форм и вопросов опроса. |
| `created` | `DATETIME_TIMESTAMPTZ` | NOT NULL | Момент создания. |
| `deleted` | `DATETIME_TIMESTAMPTZ` | — | Признак или момент удаления. |
| `is_disabled` | `BOOLEAN` | NOT NULL | Признак отключения. |

### `surveylaunch` { #pro-surveylaunch }

Запущенные опросы.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `threadid` | `INT` | FK → `chatthread.threadid`, NOT NULL | Идентификатор чата. |
| `operatorid` | `INT UNSIGNED` | NOT NULL | Идентификатор текущего оператора в чате. |
| `departmentid` | `INT UNSIGNED` | — | Идентификатор отдела текущего оператора. |
| `surveylaunchid` | `VARCHAR(32)` | NOT NULL, unique | Идентификатор запущенного опроса. |
| `configid` | `INT` | FK → `surveyconfig.id`, NOT NULL | Идентификатор конфигурации опроса. |
| `currentformid` | `INT` | — | Идентификатор текущей формы опроса. |
| `currentquestionid` | `INT` | — | Идентификатор текущего вопроса. |
| `createdts` | `BIGINT` | NOT NULL | Момент создания записи. |
| `modifiedts` | `BIGINT` | — | Момент изменения записи. |
| `state` | `VARCHAR(128)` | NOT NULL | Состояние опроса. |

### `thread_category` { #pro-thread-category }

Категории, назначенные диалогу.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `thread_id` | `INT` | FK → `chatthread.threadid`, NOT NULL | Идентификатор чата. |
| `category_id` | `INT` | FK → `category.id`, NOT NULL | Идентификатор категории. |
| `subcategory_id` | `INT` | FK → `category.id` | Идентификатор подкатегории. |

Индексы:

  * `idx_thread_category_thread_id` (`thread_id`)
  * `idx_thread_category_category_id` (`category_id`)
  * `idx_thread_category_subcategory_id` (`subcategory_id`)

### `visitor_routing_rule` { #pro-visitor-routing-rule }

Правила маршрутизации посетителей: поле посетителя, его значение и ключ размещения.

| Поле | Тип | Ограничения | Описание |
| --- | --- | --- | --- |
| `id` | `INT` | PK, NOT NULL, autoincrement | Идентификатор записи. |
| `location_key` | `VARCHAR(64)` | NOT NULL | Ключ размещения. |
| `visitor_field` | `VARCHAR(128)` | NOT NULL | Имя поля посетителя. |
| `visitor_field_value` | `VARCHAR(128)` | NOT NULL | Значение поля посетителя. |

Связанные материалы:

  * [Конфигурация СУБД](https://webim.ru/kb/devops/db-configuration.html)

  * [Менеджмент БД через wmdb](https://webim.ru/kb/devops/wmdb.html)

  * [Требования к хранилищу](https://webim.ru/kb/devops/sys-reqs-for-server/sys-reqs-server-db.html).

---

Источник: https://webim.ru/kb/devops/relational-db-structure.html
