1️⃣Widget API

Функції та механізми, якими можна керувати віджетом

1. Відкриття віджету:

JediDesk("openWidget")

Використовуйте цю функцію, щоб відкривати вікно віджета в потрібний момент.


2. Закриття віджету:

JediDesk("closeWidget") 

Використовуйте цю функцію, щоб закривати вікно віджета в потрібний момент.


3. Передача даних користувача:

JediDesk("customerData", {
    name: "Max",
    phone: "+380990000000",
    email: "[email protected]",
    note: "VIP",
    language: "en",
    custom_fields: [{
            "id": 1,
            "value": "123"
        },
        {
            "id": 2,
            "value": "test"
        },
        {
            "id": 551,
            "value": "test321"
        }
    ]
})

Використовуйте цю функцію, щоб заповнювати та передавати дані про користувача віджету в потрібний момент.


Дозволені поля для передачі:

Параметр

Тип

Опис

name

string

Імʼя користувача

phone

string

Номер телефону користувача

email

string

Email користувача

note

string

Додатковий опис користувача, нотатки

language

enum('uk', 'en', 'ru')

Мова користувача

custom_fields

array

Поля, що налаштовуються. Масив об'єктів. Параметри об'єктів:

id - унікальний id поля (призначається при створення поля в адмін-панелі).

value - значення поля.

4.AI Page Context — передача даних сторінки для AI асистента

Коли клієнт відкриває чат на сторінці конкретного товару або послуги, AI асистент може не знати, що саме переглядає клієнт. Це призводить до зайвих уточнюючих питань замість конкретної відповіді.

Передаючи дані сторінки через Widget API, ви дозволяєте AI одразу розуміти контекст звернення і відповідати точніше.

Повний приклад інтеграції

5. Підписатись на подію віджета:

Використовуйте цю функцію, щоб отримувати сповіщення про різні події, які звʼязані із віджетом.

Можливі події:

Подія

Опис

JediDeskFullyLoaded

Ініціалізація віджету повністю завершена

JediDeskOpenedWidget

Було відкрито віджет

JediDeskClosedWidget

Було закрито віджет

JediDeskClientSendMessage

Користувач відправив повідомлення менеджеру. Вміст параметра detail (e.detail): text (string) - текст повідомлення firstMessage (boolean) - чи є це повідомлення першим у діалозі

JediDeskManagerSendMessage

Менеджер відправив повідомлення користувачу. Вміст параметра detail (e.detail): text (string) - текст повідомлення hasAI (boolean) - текст згенеровано і відправлено автоматично за допомогою ШІ

Last updated