Различия

Показаны различия между двумя версиями страницы.

--- start [2026/02/18 19:46] – [setVisitorInfo#] soficlym
+++ start [2026/02/25 11:17] (текущий) – [Widget API] dmitry
@@ Строка 9: / Строка 9: @@
 [[wiki:Саджесты в чате.:start]]\\
 [[wiki:Gravity для индивидуального предпринимателя.:start]]\\
+[[wiki:Защищенный раздел.:start]]\\
 \\
 \\
@@ Строка 1090: / Строка 1091: @@
+=====GRAVITY API=====
-======GRAVITY API======
-=====Обзор=====
 =====Widget API=====
@@ Строка 1098: / Строка 1097: @@
 Доступ к методам осуществляется через глобальный объект **gravi_api**.
-=== open# ===
+====open#====
 Метод для открытия окна чата.
@@ Строка 1371: / Строка 1370: @@
 | 9 |  LINK_CLOSE | LINK_CLOSE | Соединение закрыто. (Диалог завершен)  |
+===VisitorSubscribeEvent===
+event_type: VISITOR_SUBCRIBE
+Посетитель подключился (открыл веб-страницу, зашел в Telegram канал и т.д.). Возникает, в момент, когда клиентское приложение (виджет на сайте, TelegramProxy и т.п.) подключилось к серверу приложений и авторизовалось с известным идентификатором посетителя – visitorId.
+| № | Name | Type | Description |
+| 1 | success | Boolean | Признак успешной авторизации |
+| 2 | peer | Peer | Сведения о соединении |
+| 3 | unit | Unit | Сведения об организации, владельце аккаунта |
+| 4 | visitor | Visitor | Сведения о посетителе |
+===AgentJoinEvent===
+event_type: AGENT_JOIN
+Оператор присоединился к диалогу:\\
+- написал первое сообщение в диалог;\\
+- нажал кнопку вступить в диалог;\\
+- принял переданный диалог;\\
+- принял приглашение в диалог.\\
-^ №      ^ Name      ^ Value         ^  Description         ^
+В качестве владельца будет указан последний присоединившийся оператор.
-|  1  |   |  |  |
+Операторов в диалоге может быть несколько. Их идентификаторы указаны в поле users
-|  2  |   |  |  |
-|  3  |   |  |  |
+Для одного посетителя может одновременно существовать только один диалог. Диалоги сохраняются последовательно в архиве.
-=====Chat API=====
+| № | Name | Type | Description |
+| 1 | vId | BigInt | Уникальный идентификатор посетителя |
+| 2 | owner | Int | Владелец диалога. Уникальный идентификатор оператора |
+| 3 | users | Array<Int> | Массив идентификаторов пользователей (операторов), участников диалога (для многопользовательских диалогов) |
+===AgentLeaveEvent===
+event_type: AGENT_LEAVE
+Оператор покинул диалог.
+Если диалог был однопользовательским, то выход оператора из диалога означает его закрытие. Если диалог был многопользовательским, то владелец диалога переназначается, а диалог продолжается.
+| № | Name | Type | Description |
+| 1 | uId | Int | Уникальный идентификатор оператора, покинувшего диалог |
+| 2 | vId | BigInt | Уникальный идентификатор посетителя |
+| 3 | owner | Int | Владелец диалога. Уникальный идентификатор оператора |
+| 4 | users | Array<Int> | Массив идентификаторов пользователей (операторов), участников диалога (для многопользовательских диалогов) |
+===LinkCloseEvent===
+event_type: LINK_CLOSE
+Соединение закрыто. Означает завершение диалога.
+| № | Name | Type | Description |
+| 1 | vId | BigInt | Уникальный идентификатор посетителя |
+| 2 | linkid | BigInt | Уникальный идентификатор диалога |
+| 3 | tag | Int | Тег причины закрытия:<br>0 — посетитель прервал соединение (закрыл сайт, пропало интернет-соединение и пр.)<br>1 — Оператор закрыл диалог в интерфейсе приложения<br>2 — Таймаут |
+===VisitorUpdateEvent===
+event_type: VISITOR_UPDATE
+Внесены изменения в учетную запись посетителя:\\
+- посетитель заполнил форму «Представьтесь»;\\
+- оператор внес изменения в форме диалога;\\
+- оператор внес изменений в форме «Посетитель» \\
+| № | Name | Type | Description |
+| 1 | vId | Int | Уникальный идентификатор посетителя |
+| 2 | linkid | Int | Уникальный идентификатор диалога |
+| 3 | attr | VisitorUpdateAttributes | Изменяемые атрибуты |
+===VisitorUpdateAttributes===
+Набор необязательных полей, изменяемых атрибутов в событии.
+| № | Name | Type | Description |
+| 1 | name | String | Имя пользователя (не идентификатор) |
+| 2 | email | String | Электронная почта (идентификатор) |
+| 3 | phone | String | Номер телефона (индентификатор) |
+| 4 | avatar | Data URL (Base64) | Аватар Data URL в формате base64 |
+| 5 | isBlocked | Boolean | Учётная запись активна / заблокирована |
+| 6 | tcount | Int | Количество посещений (DEPRECATED) |
+===MessageEvent===
+event_type: VISITOR_MESSAGE, AGENT_MESSAGE, TRIGGER_MESSAGE, MESSAGE_OFFLINE
+Сообщение.
+| № | Name | Type | Description |
+| 1 | Id | String (UUID v4) | Уникальный идентификатор сообщения |
+| 2 | time | Date | Дата и время сообщения |
+| 3 | mode | MessageModes | Режим сообщения |
+| 4 | isRead | Boolean | Сообщение прочитано получателем |
+| 5 | sticker | Boolean | DEPRECATED |
+| 6 | linkid | BigInt | Идентификатор сессии |
+| 7 | vId | BigInt | Идентификатор посетителя |
+| 8 | sender | User (Agent \ Visitor) | Отправитель |
+| 9 | receiver | User (Agent \ Visitor) | Получатель |
+| 10 | content | Content | Содержимое |
+=====API. Доступные типы данных=====
 Все типы, используемые в Gravity API, представлены в виде JSON-объектов.
 Тип Int - 32-битные целые числа со знаком для хранения всех целочисленных полей, если не указано иное.
@@ Строка 1563: / Строка 1656: @@
-=====Bot API=====
 ======САДЖЕСТЫ В ЧАТЕ======